Class library reference

Integration APIs

The following table lists the platform Integration APIs, with links to supporting documentation.

API Business Domain Description NET API REST API Contained in Package
Agent Status Manager Background Processing Trigger an agent to execute on-demand
  • Agent Status Manager (REST)
Analytics Conceptual Index Analytics Conceptual Perform Latent Semantic Indexing (LSI) and discover related concepts between documents
Annotations Manager Document Viewer Redact and highlight document images.
Application Install Environment Install applications into one or more workspaces, cancel pending installations, retrieve the status of application installations, and resolve conflicts for failed application installations.
ARM ARM Archive, restore, and move Relativity workspace data, and view information on currently running ARM jobs or to list available workspaces or ARM archives.
Audit Audit Revert, retrieve, and search Relativity audit records stored in Elasticsearch
Automated Workflows Automated Workflows Integrate with the Automated Workflows framework to register actions, register triggers and send triggers.
Authentication provider type Identity Enable and disable authentication protocols in use by Relativity.
Batches Manager Review Retrieve information about existing batches as well as checking batches in and out.
Batch Sets Manager Review Perform CRUD operations for batch sets, and create/purge batches for a batch set. This API is included in the
Billing Billing Retrieve billing data to check billing metrics breakdown for instance, workspace, matter, and client; check peak values and current usage for the whole instance or specific workspaces; retrieve billing user details (REST-only API) (REST-only API)
Choice Manager Object Model Retrieve choice types and choice servers, and perform CRUD operations and massive operations on choices.
Client Manager Identity Perform CRUD operations on clients; retrieve lists of available groups, matters, users, and statuses; and create, submit, and retry client domain activation keys.
Cold Storage Cold Storage  
Contracts Contracts APIs for integrating with the Relativity Contracts application. (REST-only API)
Document File Manager Object Model Download native, image, and produced image files associated with documents.
dtSearch Manager dtSearch Manage (e.g. build and activate) dtSearch Indexes.
Document Viewer Services Document Viewer Request the conversion of documents to supported viewer types (such as native, image, production, and transcript types); convert files contained in File fields on Relativity Dynamic Objects (RDOs)
Error Manager Environment Create errors that can be displayed in the Error tab.
Event Handler Manager Extensibility Attach and detach event handlers to an object type; retrieve a list of event handlers in a workspace; retrieve a list of event handlers currently attached to an object type.
Export Environment Export applications as a RAP file or schema file.
Export Service Data Import and Export APIs The Relativity Export Service API is a service designed to facilitate the efficient export of documents, images, PDFs, native files, and Relativity Dynamic Objects (RDOs) from within Relativity workspaces.
Federated Instance Manager Identity Interact with federated instances that enable users to seamlessly switch between multiple Relativity instances.
Field Manager Object Model Perform CRUD operations on fields; retrieve field information on object types; and perform other supporting helper functions related to Fields.
Field Mapping Manager Processing Perform various operations related to mapping fields between Relativity and an external data source.
Field Size Text Storage Use the Text Field Size to return the size of text in any fixed length or long text field.  
File Field Manager Object Model Upload and download files linked to file fields.
Folder Manager   Manipulate folder structures in the Relativity UI framework; create, update, or move a folder, query for folders, retrieve the root or children in a folder tree, delete empty folders; monitor progress of the delete operation on folders.
Group Manager Identity Perform CRUD operations on groups; add and remove users from a group.
Imaging Imaging Interact with imaging profiles, sets, jobs, and other related components.
Import Service Data Import and Export APIs Import large numbers of documents, images, and Relativity Dynamic Objects (RDOs) into a Relativity workspace.
Instance Setting Manager Environment Perform CRUD operations on Instance Settings; set values for Instance Settings.
Integration Points Data Import and Export APIs Provides a framework for developing custom providers for importing data to Relativity Dynamic Objects (RDOs) or other types of objects. It supports the integration of custom providers that ingest data in XML, JSON, SQL databases, or other formats. You can make these custom providers available to users through the Relativity UI (.NET-only API)
Keyboard Shortcuts Manager Review Retrieve all or a subset of keyboard shortcuts for a workspace; retrieve information about the actions that the shortcuts trigger.
Keyword Search Manager Keyword Search Perform CRUD and query operations on a KeywordSearch DTO; interact with saved searches; retrieve saved search parameters available in the workspace (such as fields, search owners, search indexes).  
Layout Manager Data Visualization Perform CRUD operations to manipulate layouts in your Relativity environment; retrieve a list of users with permissions necessary to own layouts.
Library Application Environment Read application metadata and RAP files from the library, upload new applications, and update or delete existing applications.
Login Profile Manager Identity Configure Relativity's Authentication Profile and user Login Profiles.
Mass Operations Mass Operations Perform bulk processing of Documents and RDOs in Relativity
Mass Operation Manager Extensibility Perform CRUD operations for mass operations; retrieve information about object types that be associated with a mass operation and available event handlers and layouts for use with a mass operation.
Matter Manager Environment Perform CRUD operations on matters; retrieve available clients and statuses.
Notifications Notifications Business Domain Landing Page Send emails and other notifications through Relativity.
Notifications Manager (MotD) Infrastructure Exposes methods for reading, updating, and dismissing the MotD. It also includes methods for determining whether the MotD has been dismissed, and whether it is displayed as plain text or HTML.
OAuth2 Client Manager Identity Perform CRUD operations against a Relativity instance's OAuth2Clients. (OAuth2 clients allow you to configure external services and applications to authenticate against Relativity in a secure manner.)
Object Manager Object Manager Work with Document objects and Relativity Dynamic Objects (RDOs), for example creating RDOs and setting values on their associated fields, updating fields on Document objects or RDOs, modifying the field types currently available on a Relativity object, reading fields on Document objects or RDOs, retrieving a list of dependent objects prior to deleting a specific object, performing mass operations to create RDOs, or to update and delete Document objects or RDOs, exporting objects, and retrieving Workspaces, Documents, RDOs and system types.
Object Rule Manager Data Visualization Perform CRUD operations to manage object rules that customize the behavior of the object types that you create; retrieve information about associative objects, layouts, choices and choice fields used when creating or updating an object rule.
Object Type Manager Object Model Perform CRUD operations on object types; retrieve parent object types and dependent objects.
Permission Manager Identity Assign system-defined permissions on the admin, workspace, and item level; create, update, and delete custom permissions for RDOs; read and query system-defined permissions and custom permissions.
Persistent Highlight Service Document Viewer Retrieve information about the persistent highlight sets and terms used in a specific document or workspace, set terms or highlight sets as active or inactive, and add new terms to a persistent highlight set.
Pivot Manager Pivot Run queries based on existing Pivot profiles; create and run custom Pivot queries and pass query results to another application.
Processing Custodian Manager Processing Create and update custodians.
Processing Data Source Manager Processing Create and update data source objects.
Processing Document Manager Processing Work with documents in a publishing set.
Processing Filter Manager Processing Create, update and delete filters; apply filters to data and retrieve the filtered data; retrieve filters associated with a data source or available in a specific workspace.
Processing Job Manager Processing Run or cancel inventory, discovery, and publishing jobs.
Processing Set Manager Processing Create and update processing sets.
Production Data Source Manager Production Perform CRUD operations on production data sources; retrieve default field values for a production data source.

 
Production Manager Production Create, delete, stage, run, and perform other tasks with production sets; retrieve default fields on a production; set and remove production restrictions defined in a workspace; retrieve information about production jobs such as status, progress, and production results; retrieve information about production errors and document conflicts; retrieve, run, stage and cancel re-production jobs.
Production Placeholder Manage Production Perform CRUD operations on placeholders; retrieve default field values for a placeholder.
Production Queue Manager Production Cancel a single or multiple production jobs; retry multiple jobs or set the priority for jobs; identify the jobs for canceling or retrying by mass operation token or Artifact ID
Re-production Job Manager Production Create re-production jobs; retrieve re-production job IDs; retrieve re-production job statuses.
Resource File Environment Perform CRUD operations on resource files; download resource files, update/upload file content and metadata; read all eligible applications.
Resource Server / Resource Pool Infrastructure Provide API endpoints to interact with Relativity servers
Script Manager Extensibility Add, delete, and modify a SQL script; retrieve script input parameters; preview a script; import a script; queue a script to run; retrieve the status of a script; query and export action results; export script report; clean up script results
Search Container Manager   Perform CRUD operations and query saved search folders as SearchContainer DTOs; retrieve the content of a SearchContainer (saved searches and subfolders).
Search Provider Extensibility Perform CRUD operations against Search Providers (Keyword search provider, dtSearch provider, Analytics search provider); retrieve search provider metadata.
Search Terms Report Services Search Terms Report Generate a search terms report; add terms to an existing search terms report; retry errors; view the build progress of a search terms report.
Short Message Viewer Manager Document Viewer Retrieve the JSON, attachments and participant information for short messages; validate the Relativity Short Message Format (RSMF); create new documents based on a subset of messages.
Staging Reports API Staging Reports API (REST) With this API you can enumerate folders, generate folder or file reports, retrieve lists of submitted reports, and fetch generated reports as a file. (REST-only API)

Staging Reports API V3 Reference

(REST-only API)
Structured Analytics Job Manager Structured Analytics Run an analysis of a structured analytics set; check the status of the analysis; retrieve document and set errors; monitor progress and cancel analysis.
System Artifact Manager Object Model Retrieve the System artifactID for an application that creates top-level tabs or object types.
Tab Manager Data Visualization Perform CRUD operations against tabs; retrieve information about the display order of tabs, parent tabs, and available object types that can be associated with tabs; retrieve workspace-level metadata for admin and system tabs.
Transfer Data Import and Export APIs Allows performing high-throughput transfers of files from and to Relativity environment, e.g. copy files to fileshare (.NET-only API)
Usage Usage Report API The Usage Report API provides a REST service that modernizes and centralizes the reporting experience across an instance. (REST-only API) (REST-only API)
User Manager Identity Perform CRUD operations on users; read and update settings of current users; retrieve the available user types; retrieve all users from a workspace or admin-level context.
View Manager Data Visualization Create, read, and update Relativity views; retrieve user permissions on a view and the fields used in the search conditions on the view; retrieve list of workspace users who can be assigned ownership of a view; retrieve a list of object types in a workspace.
Workspace Manager Environment Perform CRUD operations on workspaces; retrieve lists of available resources such as matters, clients, and others; retrieve information about advanced settings such as workspace statuses and full text languages for the SQL Server; retrieve Azure credentials.

Extension APIs

The following table lists the platform extension APIs, with links to supporting documentation:

Extension API Description NET API
Relativity API Helpers Include interfaces that you can program against when developing agents, custom pages, and event handlers. They provide the ability to write common code for sharing across these extensibility points to simplify your development processes
Agents Build and deploy custom background processes to handle long running tasks or batch operations
Custom Pages Use Custom Pages to create your own look and feel for applications that you develop on the Relativity platform
Event handlers Enhance certain common activities with pre- and post-actions
Custom / Kepler APIs Use the Kepler hosting library to deploy your own REST APIs within Relativity