Sitemap

Explore
Developer News
Platform Change log
Release Notes (New Interface)
Database schema updates
Relativity Server SDK and API Packages Changes
Tutorials
Learn about developing with Relativity
Lesson 1 - Set up your developer environment
Lesson 2 - Build an application without any code
Lesson 3 - Create a RESTful API
Lesson 4 - Validate object changes
Lesson 5 - Build a cron job
Lesson 6 - Build a custom page
Lesson 7 - Use Relativity Forms to enhance the UI
APIs
SDK and API Comparison: RelativityOne vs Relativity Server
Tools and Resources
Visual Studio templates
Publish to Relativity tool
Core concepts for developers
Artifact identifiers
Relativity API error handling
Relativity Dynamic Objects (RDOs)
Editing Relativity Objects
Deleting object dependencies
Creating a question object
Building Media Tracker with Relativity Dynamic Objects
Creating a tab to bookmark an object
Object Manager Fundamentals
Query for resources
Testing custom applications
Logging
Log from a Relativity application
Configure logging
Troubleshoot Relativity using logging
System-subsystem-application matrix for logging
Infrastructure considerations for logging
Targeting different nuget repositories
Documentation archives
Integrate
Introduction to Relativity APIs
Integration fundamentals and concepts
REST API overview
Basic REST API concepts
Architecture
Authentication
HTTP headers
HTTP status codes
Troubleshoot errors
Tutorials for integrating with Relativity
Storing and using external API credentials
Integration Tools and Resources
Integration APIs and Services
ARM
ARM (.NET)
ARM .NET API Reference
ARM API (REST)
Audit
Audit (.NET)
Audit .NET API Reference
Audit (REST)
Audit REST API Reference
Data Import and Export APIs
Import API
Get started
Import data into RDOs
Import images
Import produced images
Import documents with native files
Best practices
Basic Concepts
ImportAPI class
ImportBulkArtifactJob class
Import API events
Work with data grid
Deploy Import API applications
Troubleshooting
Handle errors and exceptions
Relativity Integration Points
Best Practices
Build your first integration point
Build an advanced integration point
Troubleshooting
Transfer API
Data Visualization
Layout Manager (.NET)
Layout Manager (REST)
Object Rule Manager (.NET)
Object Rule Manager (REST)
Tab Manager (.NET)
Tab Manager (REST)
View Manager (.NET)
View Manager (REST)
Data Visualization .NET API Reference
Data Visualization REST API Reference
Document Viewer
Annotations Manager (.NET)
Annotations Manager (REST)
Document Viewer Services (.NET)
Document Viewer Services (REST)
Persistent Highlight Service (.NET)
Persistent Highlight Service (REST)
Short Message Viewer Manager (.NET)
Short Message Viewer Manager (REST)
Document Viewer .NET API Reference
dtSearch
dtSearch Manager (.NET)
dtSearch .NET API Reference
dtSearch Manager (REST)
dtSearch REST API Reference
Legacy API
Legacy dtSearch Manager (.NET)
Legacy dtSearch Manager (REST)
Environment
Application Install (.NET)
Application Install (REST)
Error Manager (.NET)
Error Manager (REST)
Export (.NET)
Export (REST)
Instance Setting Manager (.NET)
Instance Setting Manager (REST)
Library Application (.NET)
Library Application (REST)
Matter Manager (.NET)
Matter Manager (REST)
Resource File (.NET)
Resource File (REST)
Workspace Manager (.NET)
Workspace Manager (REST)
Environment .NET API Reference
Environment REST API Reference
Extensibility
Event Handler Manager (.NET)
Event Handler Manager (REST)
Mass Operation Manager (.NET)
Mass Operation Manager (REST)
Script Manager (.NET)
Script Manager (REST)
Search Provider (.NET)
Search Provider (REST)
Extensibility .NET API Reference
Identity
Authentication provider type (.NET)
Authentication provider type (REST)
Client Manager (.NET)
Client Manager (REST)
Federated Instance Manager (.NET)
Federated Instance Manager (REST)
Group Manager (.NET)
Group Manager (REST)
Login Profile Manager (.NET)
Login Profile Manager (REST)
OAuth2 Client Manager (.NET)
OAuth2 Client Manager (REST)
Permission Manager (.NET)
Permission Manager (REST)
User Manager API
User Manager service
Relativity Identity .NET API Reference
Relativity Identity REST API Reference
Imaging
Imaging (.NET)
Imaging .NET API Reference
Imaging API (REST)
Imaging REST API Reference
Infrastructure
Agent Manager
Agent Manager (.NET)
Agent Manager .NET API Reference
Agent Manager (REST)
Notifications Manager (MotD) - (.NET)
Notifications Manager (MotD) - (REST)
Notifications REST API Reference
Resource Server / Resource Pool (.NET / REST)
Resource Server Resource Pool REST API Reference
Infrastructure .NET API Reference
Keyword Search
Keyword Search Manager (.NET) for saved searches
Keyword Search Manager (REST) for saved searches
Search Container Manager (.NET)
Search Container Manager (REST)
Logging
Logging .NET API Reference
Logging Interfaces .NET API Reference
Notifications
Notifications (.NET)
Notifications .NET API Reference
Notifications (REST)
Object Manager
Object Manager (.NET)
Object Manager .NET API Reference
Object Manager (REST)
Object Manager REST API Reference
Migrating code to the Object Manager API
Object Model
Choice Manager (.NET)
Choice Manager (REST)
Document File Manager (.NET)
Document File Manager (REST)
Field Manager (.NET)
Field Manager (REST)
File Field Manager (.NET)
File Field Manager (REST)
Object Type Manager (.NET)
Object Type Manager (REST)
System Artifact Manager (.NET)
System Artifact Manager (REST)
Object Model .NET API Reference
Pivot
Pivot Manager (.NET)
Pivot Manager (REST)
Processing
Get started with the Processing API
Processing API services for REST
Processing Custodian Manager
Processing Custodian Manager (REST)
Processing Data Source Manager
Processing Data Source Manager (REST)
Processing Document Manager
Processing Document Manager (REST)
Processing Filter Manager
Processing Filter Manager (REST)
Processing Job Manager
Processing Job Manager (REST)
Processing Set Manager
Processing Set Manager (REST)
Field Mapping Manager
Field Mapping Manager (REST)
Processing .NET API Reference
Processing REST API Reference
Troubleshooting Processing API errors
v0
Processing API services for REST (v0)
Field Mapping (.NET v0)
Field Mapping (REST v0)
Processing Filter Manager (.NET v0)
Processing Filter Manager (REST v0)
Production
Production Manager (.NET)
Production Manager (REST)
Production Data Source Manager (.NET)
Production Data Source Manager (REST)
Production Placeholder Manager (.NET)
Production Placeholder Manager (REST)
Production Queue Manager (.NET)
Production Queue Manager (REST)
Re-production Job Manager (.NET)
Re-production Job Manager (REST)
Production .NET API Reference
Production REST API Reference
Review
Batch Sets Manager (.NET)
Batch Sets Manager (REST)
Batches Manager (.NET)
Batches Manager (REST)
Keyboard Shortcuts Manager (.NET)
Keyboard Shortcuts Manager (REST)
Review .NET API Reference
Search Terms Report
Search Terms Report Services (.NET)
Search Terms Report .NET API Reference
Search Terms Report Services (REST)
Telemetry APM
Telemetry APM .NET API Reference
Telemetry DataContracts Shared .NET API Reference
Telemetry MetricsCollection .NET API Reference
Telemetry MetricsCollection Interfaces .NET API Reference
Telemetry Services Interfaces .NET API Reference
Text Storage
Field Size API
Extend
Introduction to Relativity extensions
Tutorials for extending Relativity
Set up a developer environment
Build your first Relativity application in the UI
Build a custom page
Build your first event handler
Build your first agent
Storing and using external API credentials
Relativity application framework
Basic concepts
Loading application resources
Best practices
Create an application in Relativity
Advanced functionality
Troubleshoot application errors
Platform Extension APIs
Agents
Basic concepts
Best practices
Advanced functionality
Troubleshoot agents
Agent Status Manager .NET API Reference
Kepler APIs
Template for Kepler services
Kepler service structure and components
Proxies and authentication
Cancellation and progress
Serialization and streaming
HTTP headers, verbs, and related information
Dependency Injection
Deploy Kepler services through ADS
Troubleshooting Kepler services
Kepler SDK .NET API Reference
Kepler Client SDK .NET API Reference
Custom pages
Basic concepts
Best practices
Publish and upload custom pages
Advanced functionality for custom pages
Troubleshoot custom pages
Custom Pages .NET API Reference
Event handlers
Basic concepts
Best practices
Add event handlers to applications
Develop object type event handlers
Console event handlers
Page Interaction event handlers
List Page Interaction event handlers
List Page Interaction Event Handler API
Post Save event handlers
Pre Cascade Delete event handlers
Pre Delete event handlers
Pre Load event handlers
Redirect a user to a layout
Pre Mass Delete event handlers
Pre Save event handlers
Support for File fields
Develop application event handlers
Pre and Post Install event handlers
Pre Install event handlers
Post Install event handlers
Pre Uninstall event handlers
Post Workspace Create event handlers
Pre Workspace Delete event handlers
Develop Mass Operation handlers
Advanced functionality for event handlers
Troubleshooting
Event Handler .NET API Reference
Relativity API Helpers
Basic concepts
Code sample for database interactions
Relativity API Helpers .NET API Reference
UI Customization APIs
Relativity Forms API
Migrating applications to Relativity Forms
Sample: Converting a Classic Form to a Relativity Form
Implementing Relativity Forms event handlers
Debug Relativity Forms Event Handlers
Load pipeline
Change pipeline
Submit pipeline
Delete pipeline
convenienceAPI object
this Binding
Item list event handlers
Additional Forms API objects
Layout representation for Relativity forms
Communicate between Relativity Form pages
Examples
Add a custom item list to a layout
Review API
Scripting
Use scripts in Relativity
Create a new Relativity Script
Best practices
Global script variables
Script Properties
action
category
description
display
settings
input
constant
field
filters
category
type
object
search
searchprovider
sql
key
name
script
security
acl
version
API Reference
.NET APIs
Relativity.Server.Agent.SDK
Relativity.Server.API.SDK
Relativity.Server.Application.SDK
Relativity.Server.ARM.SDK
Relativity.Server.Audit.SDK
Relativity.Server.CustomPages.SDK
Relativity.Server.DataTransfer.SDK
Relativity.Server.DataVisualization.SDK
Relativity.Server.DocumentViewer.SDK
Relativity.Server.DtSearch.SDK
Relativity.Server.Environment.SDK
Relativity.Server.EventHandler.SDK
Relativity.Server.Extensibility.SDK
Relativity.Server.Identity.SDK
Relativity.Server.Imaging.SDK
Relativity.Server.Import.SDK
Relativity.Server.Infrastructure.SDK
Relativity.Server.Kepler.Client.SDK
Relativity.Server.Logging.SDK
Relativity.Server.Logging.Interfaces.SDK
Relativity.Server.Notifications.SDK
Relativity.Server.OAuth2.SDK
Relativity.Server.OAuth2.Implicit.SDK
Relativity.Server.OAuth2.Interfaces.SDK
Relativity.Server.ObjectManager.SDK
Relativity.Server.ObjectModel.SDK
Relativity.Server.OutsideIn.Fi.Win32.SDK
Relativity.Server.Processing.SDK
Relativity.Server.Productions.SDK
Relativity.Server.Review.SDK
Relativity.Server.Rsapi.SDK
Relativity.Server.SDK
Relativity.Server.SearchTermsReport.SDK
Relativity.Server.Services.DataContracts.SDK
Relativity.Server.Services.Interfaces.SDK
Relativity.Server.Shared.SDK
Relativity.Server.Telemetry.APM.SDK
Relativity.Server.Telemetry.DataContracts.Shared.SDK
Relativity.Server.Telemetry.MetricsCollection.SDK
Relativity.Server.Telemetry.MetricsCollection.Interfaces.SDK
Relativity.Server.Telemetry.Services.Interfaces.SDK
Relativity.Server.Testing.Framework.SDK
Relativity.Server.Testing.Framework.Api.SDK
Relativity.Server.Transfer.SDK
Relativity.Server.Utility.SDK
REST APIs
relativity-audit
relativity-data-visualization
relativity-dtsearch
relativity-environment
Relativity-Identity
relativity-imaging
relativity-notifications
Relativity.ObjectManager
relativity-telemetry
relativity-processing
relativity-productions
JavaScript APIs
Relativity Forms API
Return to top of the page
Feedback