

Last date modified: April 11 2025
Welcome to the developer news page! This topic describes upcoming changes, the status of ongoing initiatives, and noteworthy release and deprecation changes that may impact Relativity Developers. You can also review and subscribe to postings on the Relativity Developer Group for more announcements.
Note: Due to differences in deployment and update schedules, the items listed below may not yet exist in all environments on the date indicated.
This section describes notable upcoming functionality and changes that may interest Relativity developers. This includes potential breaking changes that you may need to prepare for. Refer to the Upcoming Changes section in the Platform Change log for more upcoming changes information.
Lucene Search is being deprecated in both the Audit UI and API and will be removed starting June 2, 2025. In its place, we are introducing basic keyword filtering capabilities using the "is like" and "is not like" operators on the Details field. This change affects how users filter audit records and may require adjustments to existing workflows. See this post in the developer group for more information.
The Collect Folder Path Data solution (which reports the total number and size of document files in each workspace and folder in a Relativity instance) is being deprecated and will be removed starting June 5, 2025. The deprecation includes the application, agents, event handlers, and the script for this solution. See this post in the developer group for more information.
Due to the upcoming migration of Relativity.ListPage to Relativity.Lists, you will need to migrate List Page Interaction Event Handlers that use a JavaScript code file to call the JavaScript APIs, to use the new file format and APIs. See this post in the developer group for more information.
This section highlights current initiatives, programs or other ongoing improvements that may impact Relativity developers. These initiatives may span multiple product updates or versions, so check back often for the latest updates.
Relativity is embarking on a journey to bring hyper-scale cloud compute capabilities to the platform. See the Platform Architecture Changes topic for more detail on this initiative, the planned schedule for these changes and how the changes may affect you.
This section describes released items noteworthy to Relativity Developers. You can also review the RelativityOne release notes topic in the User Guide for a comprehensive list of released changes, and for a comprehensive sortable and filter-able list of changes impacting developers, please see the Platform change log table.
The Audit Metrics REST API endpoint that returns Audit Record Count and Audit Record Size (in bytes) is deprecated. After March 16, 2025, queries to this endpoint will return 0. The endpoint will be fully retired on October 1, 2025. See this post in the developer group for more information.
Lucene Search Engine support in the Audit User Interface and Audit API is removed from production RelativityOne instances. After the deprecation, you will no longer be able to use the keyword LuceneSearch in the request.condition or request.rowCondition in the Audit API. See this post in the developer group for more information.
The Analytics Classification API (.NET and REST) was removed from RelativityOne on December 20, 2024. See this post in the developer group for more information.
The Object Manager REST API returns a 554 status code if an event handler causes Object Manager's REST API to fail. The 554 error will help you troubleshoot when operations fail due to an issue with event handlers. See this post in the developer group for more information.
The DataExchange.Client.SDK is deprecated in RelativityOne as of December 2, 2024. The Relativity.Import.SDK replaces the DataExchange.Client.SDK. See this post in the developer group for more information.
The Solution Snapshot application will no longer be supported for Relativity Server as of October 29, 2024. All supporting documentation and access to the RAP will be removed at that time, and no further changes will be made to the application. See this post in the developer group for more information.
RelativityOne Staging boundaries are streamlined to effectively separate staging data from workspace and system data. With this change, you will no longer be able to write to or access data outside of the defined staging area. The FTA, Temp, Export and dtSearch folders will be removed. For more detail, please reference the Staging Area FAQ community article.
The Relativity Testing Framework (RTF) for RelativityOne is no longer available as of May 31, 2024. All supporting documentation and access to the NuGet package has been removed and no further changes will be made to the application. Developers should move to using the Relativity APIs directly as a better, truer indication of test. See this post in the developer group for more information.
Note: RTF will continue to be supported for Relativity Server. Effective with the Server 2023 release you can find the latest RTF SDK package on the Server SDK package feed here. For more information on the Server SDK feed and go-forward Server SDK strategy please see this topic.
The API Explorer application is no longer supported for RelativityOne nor Relativity Server as of May 20, 2024. All supporting documentation and access to the RAP file has been removed, and no further changes will be made to the application. See this post in the developer group for more information.
Object Manager consumers on a per-application basis will no longer be able to exceed 1,000 requests per minute per Web Server. Upon reaching this limit, Object Manager will respond with an exception (429 - Too many Requests) and will reject the request. This change was applied to Sandboxes on December 20th, 2023 and in Production environments on March 20th, 2024. See the topic Rate limit for best practices and code samples to cater for the rate limiting feature, and see this post in the developer group for more information.
Relativity.Transfer.Client versions 7.4.10 and below stopped functioning on January 31, 2024, due to the migration of Relativity data transfer products to cloud-based solutions. If your code contains a reference to Relativity.Transfer.Client, you will need to update your code to integrate with Relativity.Transfer.SDK, version 1.0.0+. See this post in the developer group for more information.
The Send to CaseMap mass operation is being deprecated in RelativityOne and will be removed around November 28, 2023. If you bulk-send items to your CaseMap database (versions 7 and above) using the mass operation and require similar functionality in RelativityOne, our Case Dynamics product offers similar capabilities. See this post in the developer group for more information.
This developer documentation site has been significantly updated to better support Relativity developers. Some noteworthy improvements include:
The unversioned Production APIs will be deprecated and no longer supported as of July 28, 2023. If your .NET code contains a reference to Relativity.Productions.Client or you are calling the non-versioned Production service URLs, you will need to update your code to use Relativity.Productions.SDK or alternatively target the versioned REST service URLs. See this post in the developer group for more information.
The unversioned Audit API will be deprecated in June 2023. If your .Net code contains a reference to Relativity.Audit.Services.Unversioned.Interfaces or you are calling the non-versioned service URL, you will need to update your code. See this post in the developer group for more information.
Agents will no longer connect to all file shares by default on startup. Instead, Agents must interact with a fileshare directly to receive a connection. See this post in the developer group for more information.
The new Billing API supports programmatically retrieving billing data to check billing metrics for instance, workspace, matter, and client; checking peak values and current usage for the whole instance or specific workspaces; and retrieving billing user details. See Billing Insights API (REST)
DataExchange.Client.SDK versions lower than 1.17.2 stopped working on 30th of September 2022. This change will impact 3rd party solutions or applications that use Import API SDK to ingest metadata and documents into RelativityOne See this post in the developer group for more information.
The new OpenID Connect (OIDC) Provider Manager API supports programmatically creating, reading, updating, and deleting OIDC providers. It also includes functionality for CRUD operations on group claim mappings and required claims. The OIDC Provider Manager service exposes REST endpoints with these same features. This versioned API is available in the Relativity.Identity.SDK. For more information, see OpenID Connect Provider Manager (.NET) and OpenID Connect Provider Manager (REST).
Custom Agents now run on RelativityOne compute, which enables improved agent performance and stability. Starting April 2022 and into early May 2022, custom agents will be migrated to RelativityOne compute. Agents running in RelativityOne may need to be updated to comply with the requirements of the new scalable and extensible cloud platform. Following the migration, non-compliant agents may experience negative behaviors in RelativityOne.
Following the removal of RSAPI from RelativityOne, remaining RSAPI content has been removed from this developer guide. You can refer to the RSAPI deprecation process topic in the Relativity Server documentation for more information, such as the replacement APIs for removed RSAPI features.
Import SDK versions lower than 1.15.27 stopped working on 15th of February 2022. See the post in the developer group for more information.
The Table of Contents is re-organized and updated to help you find content more easily.
The content in the Deprecated Functionality topic has moved to the Platform change log to make it easier for you to see all changes in a release or of a certain type in one place. You can use the Breaking change and Deprecated filter options in the Platform change log table to display only deprecated items and breaking changes.
To reduce the size of the Platform Change Log topic and make it easier to find relevant changes, entries prior to 1/1/2019 have moved to the Platform change log (Archive) topic.
Classic Viewer is deprecated in October 2021 with the Sundrop release (12.3). Viewer extensions that only work with the Classic Viewer will no longer be accessible. Extension code will need to be migrated to the Review API to remain operational. See the Viewer Extension Migration Guide for more information.
The Structured Analytics Job Manager is now versioned. The related namespaces have been updated to include the business domain and version number, as exemplified by Relativity.StructuredAnalytics.V1. The URLs used through REST also include these updates, as exemplified by relativity-structured-analytics/v1. Additionally, the API includes these changes:
For more information, see Structured Analytics Job Manager (.NET) and Structured Analytics Job Manager (REST).
The new Agent Status Manager API supports programmatically triggering the execution of an agent outside of its standard interval runs. This process can be used to reduce latency in custom agents when responding to certain events and it is only available to agents after migration. For more information, see Execution patterns for agents.
The new Annotations Manager .NET API and REST endpoints support programmatically redacting and highlighting document images. It contains methods for creating, updating, retrieving, and deleting redactions and highlights. For more information, see Annotations Manager (.NET) and Annotations Manager (REST).
The Audit APIs are now versioned. The namespaces have been updated to include the business domain and version number, as exemplified by Relativity.Audit.Services.Interfaces.V1. The URLs used through REST also include these updates, as exemplified by relativity-audit/v1. For more information, see Audit (.NET) and Audit (REST).
The new Short Message Viewer Manager API supports programmatically interacting with messages displayed in the Short Message Viewer in the Relativity UI. It exposes methods for retrieving the JSON, attachments, and participant information for short messages. It also provides endpoints for validating the Relativity Short Message Format (RSMF)
The Identity APIs are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Identity.V1.Services. The URLs used through REST also include these updates, as exemplified by relativity-identity/v1. These include the following APIs:
For more information, see Identity (authentication and user accounts).
Additionally, the Imaging API and REST service includes the following enhancements:
The Infrastructure APIs are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Infrastructure.V1. The URLs used through REST also include these updates, as exemplified by relativity-infrastructure/v1. These include the following APIs:
For more information, see Infrastructure.
The APIs within the ObjectModel.SDK are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.ObjectModel.V1. The URLs used through REST also include these updates, as exemplified by relativity-object-model/v1. For more information, see Object Model.
The Production API is now versioned. The namespaces have been updated to include the business domain and version number, as exemplified by Services.V1.IProductionManager. The URLs used through REST also include these updates, as exemplified by relativity-productions/v1. For more information, see Production.
Additionally, the Production API include multiple enhancements available through .NET and REST:
This section contains items released in previous versions of RelativityOne (i.e. versions released prior to 2021-04-24).
The following enhancements are available in the
Relativity applications now has two groups of components. Hosted components, which are installed for the entire instance of Relativity and Workspace components, which are installed into workspaces.
The Application Install API includes an update to the field Version, which has been renamed to SchemaVersion.
The Client Manager API is a newly exposed API that allows the create, read, update, and delete methods to be used on Client objects. The API supports querying groups, matters, or users related to a given client.
The custom pages now include a Readiness check URL. The Readiness Check URL will be called by the hosting system before any client traffic is routed to the new version of your custom page. This gives you the opportunity to perform final checks if your custom page is functional and setup as expected.
Changes were made to the EDDS and Workspace databases to accommodate new functionality in this release of Relativity. To see a list of those changes, see the Relativity 11.2 Database Schema Updates knowledge base article on the Relativity Community. Note that you need valid Community credentials to access this article.
The dtSearch Manager API includes an update to the CompressIndexAsync() method. The method contains a new boolean field, activateIndex, which determines if the index is activated after completion of the job.
For more information, see dtSearch Manager API. The dtSearch Manager service includes the same update to the CompressIndexAsync() endpoint. For more information, see dtSearch Manager Service.
Note: The existing CompressIndexAsync method/endpoint without the activateIndex field will still exist; it will simply call the new CompressIndexAsync() with the value of true for activateIndex.
The Group Manager API is a newly exposed API designed to create, read, updated, and delete groups within Relativity.
The Library Application API now includes the new following updates:
With Lanceleaf, the Relativity Forms API introduces some advanced functionality for custom pages. For example, you can enhance custom pages with Windows authentication methods.
The Review API now supports the implementation of Hydro Custom Viewers within Relativity.
The Resource Pool API is a newly exposed API that supports the ability to create, read, update, and delete resource pools within Relativity. This API supports mass additions and mass removals of resources from resource pools, and provides helper methods to retrieve eligible resources.
The Resource Server API is a newly exposed API designed to interact with resource servers in Relativity. The type of interaction is based on the type of server. Some server types can be created and deleted and most of them can be read or edited to some degree. The API also exposes methods that allow to perform actions on a specific server type, like restart the windows service or clear the cache, usually accessible via console in the Relativity UI.
The Tab Manager API team has added a new endpoint to the existing version of the tab manager for the Lanceleaf release. The new endpoint, GetAllNavigationTabs(), retrieves a list of all tabs in a specified workspace that the calling user can navigate to.
The User Manager API is a newly exposed API that exposes multiple operations that you can use to programmatically manage users in your Relativity environment. The API supports create, read, update, and delete operations on users while providing helper methods used to retrieve the available user types.
The Workspace Manager API is a newly exposed API that allows for the creation, reading, updating, and deletion of workspaces. Major use cases for this API include the creation, modification, and retrieval of information about a given workspace.
The following enhancements are available in the
The Auth Profile Manager API now supports specifying scopes for an OpenID Connect Provider. The OpenIdConnectProviders class has the new Scopes property, which is used to specify a list of scopes that a client can request. This class is available in the Relativity.Services.Security.Models namespace in the Relativity Services API.
Additionally, Auth Profile Manager service also supports specifying a list of scopes for an OpenID Connect Provider through REST.
The Object Manager APIs are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.ObjectManager.V1. The URLs used through REST also include these updates.
The Object Rule Manager API available through the Object Type Manager API now exposes the new MassDeleteAsync() method, which removes multiple object rules across different object types. Its parameters include the Artifact ID of a workspace and a list containing the Artifact ID for each rule that you want to delete. This method is available on the IObjectRuleManager interface in the Relativity.Services.Interfaces.ObjectRules namespace in the Relativity Services API.
Additionally, the Object Rule Manager service includes a new mass delete endpoint that supports removing multiple object rules in a single call.
The Processing API now includes the following new methods:
These methods are available on the IProcessingModule interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. For more information, see Processing API services for REST.
The Production API now includes the MassRetryAsync() method, which is available in the Relativity.Productions.Services namespace. Use this method to retry multiple production error or delete jobs in a single call. See Production Manager API.
Through REST, the Production Manager service also includes this new endpoint. See Production Manager Service.
The Relativity Integration Points API includes the following updates:
New namespace name | Deprecated namespace name |
---|---|
Relativity.IntegrationPoints.Contracts | kCura.IntegrationPoints.Contracts |
Relativity.IntegrationPoints.Services.Interfaces.Private | kCura.IntegrationPoints.Services.Interfaces.Private |
Relativity.IntegrationPoints.SourceProviderInstaller | kCura.IntegrationPoints.SourceProviderInstaller |
Note: For compatibility with
The following enhancements are available in the
Select REST APIs now provide specific error codes to improve error handling. For example, updates to these APIs include returning specific 400 errors codes rather than a generic 500 server errors. For guidelines about API errors, see API error handling.
The following list includes the APIs with updated REST error codes:
The new API Explorer provides an interactive way for you to reference our APIs. It lists our core Relativity REST services, which are organized into modules that you can use to perform CRUDQ operations on a Relativity resource. Each module contains the URLs for service endpoints, the ability to view fields used in the payload request, and information about fields returned in a response.
The Application Install API now includes this new endpoint:
CancelAllAsync - This endpoint cancels all pending application installs associated with a specified application. For more information, see Application Install API.
The new Choice Manager API exposes multiple operations you can use to programmatically manage choices in your Relativity environment. It supports CRUD and massive operations on choices and provides helper methods used to retrieve choice types and choice servers. For more information, see Choice Manager API.
The Document Viewer Services API now allows you to change the default persistent highlight set or terms. Additionally, you can make terms or highlight sets inactive as desired. The SavePersistentHighlightSetState endpoint also supports this functionality through REST. For more information, see the Document Viewer Services API and the Document Viewer Services in REST.
The new dtSearch Manager API includes methods that programatically manage dtSearch Indexes including CRUD operations, index build operations, and helper methods use to retrieve active indexes, saved searches, index share locations, and dtSearch index build progress. For more information, see dtSearch Manager API.
Additionally, the new dtSearch Manager services expose endpoints that support this same functionality through REST. For more information, see dtSearch Manager Service.
Note: The Legacy dtSearch Manager API is being deprecated in a future release. When implementing custom functionality, use the new dtSearch Manager API and the services that it exposes through REST.
The Field Manager API now includes the new GetRelationalOrderAsync() method. It retrieves information about the order used to display relational field icons in the Related Items pane of the core reviewer interface for a specific workspace. The new RelationalFieldOrder class is returned by this method, and its properties include the name and type of the relational field, and display order of the field icon.
The GetRelationalOrderAsync() method is available on the IFieldManager Interface in the Relativity.Services.Interfaces.Field namespace. The RelationalFieldOrder class is available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET).
Additionally, the new availablerelationalorder endpoint provides this same functionality through REST. For more information, see Field Manager (REST).
The Library Application API now includes these new endpoints:
For more information, see Library Application API.
The Object Rule Manager API available through the Object Type Manager API includes the following updates:
These classes and enumeration are available in the Relativity.Services.Interfaces.ObjectRules.Models namespace in the Relativity Services API.
Additionally, the Object Rule Manager service includes the following updated endpoints:
The Production Manager API now includes these new endpoints:
These methods are available in the Relativity.Productions.Services namespace. See Production Manager API.
Through REST, the Production Manager service also includes these new endpoints. See Production Manager Service.
You can now define a multiple object field between a RDO and a field object, which means that fields can be set as an associative object type when creating a multiple object field.
With the new Relativity Kepler framework, you can build HTTP services for REST via a .NET interface. You can implement Kepler services using standard .NET contracts, which the framework uses to build HTTP endpoints. Your Kepler service is then deployed in Relativity as part of a custom application built on the Application Deployment System (ADS). Additionally, the Kepler framework includes a client proxy that you can use when interacting with the services through .NET. For more information, see Kepler framework.
Note: During November 2019, we will be releasing the new Kepler framework used to build HTTP services for REST via .NET interfaces. The Relativity.Kepler nugget package and Kepler Visual Studio template will be also be public at this time.
The new Search Provider API includes methods to programatically create, read, update, delete, and retrieve a dependency list of search providers. For more information, see Search Provider API.
Additionally, the new Search Provider services expose endpoints that support this same functionality through REST. For more information, see Search Provider service in REST.
Note: The Legacy Search Provider Manager API is being deprecated in a future release. When implementing custom functionality, use the new Search Provider API and the services that it exposes through REST.
The new Search Terms Report Services API includes methods to generate a search terms report, adding terms to an existing search terms report, retry any errors, and view the build progress of a specific search terms report. For more information, see Search Terms Report Services API.
Additionally, the new Search Terms Report services expose endpoints that support this same functionality through REST. For more information, see Search Terms Report Services in REST.
The following enhancements are available in the
The Application Install API allows clients to install applications into one or more workspaces, cancel pending installations, as well as get the status of any specified application installations. Additionally, this API allows support for conflict resolution for any failed application installations. For more information, see Application Install API.
The new Document File Manager API exposes methods for downloading native, image, and produced image files associated with documents in Relativity. You can download a file by specifying its GUID, or you can download a native file by specifying the Artifact ID of the document associated with it. The Document File Manager API also supports retrieving information about these files, such as GUID, name, type, size, and others.
These methods are available on the IDocumentFileManager interface in the Relativity.Services.Interfaces.Document namespace. The class and enumerations supporting this functionality are available in the Relativity.Services.Interfaces.Document.Models namespace. For more information, see Document File Manager (.NET).
Additionally, the Document File Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Document File Manager (REST).
The Document Viewer Services API now allows you to view information about the persistent highlight sets and terms in a specific document and workspace. The GetPersistentHighlightSets endpoint also supports this functionality through REST. For more information, see Document Viewer Services API and Document Viewer Services in REST.
The Field Manager API now has the new Source property on the FieldResponse class. This property references a FieldSource object, which contains information about mapping the current field to a processing field. The FieldResponse class is available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET) .
In REST, the Field Manager service also now includes the Source field on the JSON response returned by the read endpoint. For more information, see Field Manager (REST).
Note: For compatibility with
The Import API includes the following enhancements:
The delivery of the Import API as a NuGet package offers the advantages of simplifying deployment by handling dependencies. The NuGet package also handles Import API versioning and deployment requirements, as well as updates.
Note: The Relativity.Import.Client NuGet package has now been deprecated. Any existing Import API applications must now be migrated to the new Relativity.DataExchange.Client.SDK NuGet package. If you don't migrate your applications to this package, they will fail.
Note: You must now use the File Identification API because the kCura.OI.FileID assembly is no longer supported.
The Library Application API allows clients to read application metadata and RAP files from the library, upload new applications, and update or delete existing applications. For more information, see Library Application API.
The Matter Manager service exposes multiple endpoints that you can use to programmatically manage matters in your Relativity environment. It includes the following features:
For more information, see Matter Manager API.
The Export API available through the Object Manager API now includes the new RetrieveResultsBlockFromExportAsync() method, which retrieves a specific block of document fields from an in-progress export job. The document fields are specified by calling this method with the index ID for a block of records in a batch, the number of records to export, the workspace ID, and the in-progress export ID. This method is available on the IObjectManager interface in the Relativity.Services.Objects namespace. For more information, see Object Manager (.NET).
The Export service also supports this same functionality with a new endpoint available through REST. For more information, see Object Manager (REST).
The Processing API now includes the following new method:
This method is available on the new IProcessingFilterManager interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. For more information, see Processing Filter Manager.
Additionally, the new methods are available through REST and provide the same functionality as available through .NET. For more information, see Processing Filter Manager (REST).
Note: The Processing Filters Manager API is a preview release, which will continue to undergo contract changes in future releases.
The Tab Manager API now includes several modified fields.
The Tab Manager API also includes new fields on the Parent and ObjectType sub-objects of the Tab object.
For C# code samples and additional information, see Tab Manager API.
Through REST, the Tab Manager service also includes the modified and new fields. For additional information, see Tab Manager service.
The View Manager API now includes the following new methods:
Additionally, the View Manager API service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see View Manager service.
Additionally, the View Manager API service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see View Manager service.
The following enhancements are available in the
The new Audit APIs include methods that programmatically revert, retrieve, and search Relativity audit records stored in Elasticsearch. These services support interactions with both instance-level and workspace-level audit records. For more information, see Audit (.NET).
The following APIs provide methods for this functionality:
Additionally, the new Audit services expose endpoints that support this same functionality through REST. For more information, see Audit (REST).
Note: The Legacy Audit API is being deprecated in a future release. When implementing custom functionality, use the new Audit APIs and the services that they expose through REST.
In the Document Viewer Services API, the GetViewerContentKeyOptions class now includes a new property called ClientId. This property represents a string value that indicates the client ID of the application caller, such as DocumentViewer.Conversion.PreConvert.
Through REST, the Document Viewer Services supports the same functionality. For more information, see Document Viewer Services (REST).
Note: For compatibility with
The new Field Manager API includes multiple operations for programmatically working with field types supported by Relativity, including multiple choice, fixed length text, date, and other fields. It exposes methods for create, read, update, and delete operations on fields. It also provides helper methods for retrieving available object types, views, keyboard shortcuts, and other information about properties that can be set on fields. These methods are available on the IFieldManager Interface in the Relativity.Services.Interfaces.Field namespace. The classes and enumerations supporting this functionality are available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET).
Additionally, the Field Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Field Manager (REST).
The Imaging API now supports programmatically updating the priority of an imaging job. The new UpdateJobPriorityAsync() method is available on the IImagingJobManager interface. The Imaging API also includes the new UpdateJobPriorityRequest and UpdateJobPriorityResponse classes used by the update method. This method and classes are available in the Relativity.Imaging.Services.Interfaces namespace. For more information, see Imaging (.NET).
Note: Beginning with the RelativityOne Foxglove release, the DLL for the Imaging API is available as a NuGet package called Relativity.Imaging.SDK. The Imaging SDK will no longer be published in the Community, but you can easily add the NuGet package to your project through Visual Studio. For more information, see Quickstart: Install and use a package in Visual Studio on the Microsoft website.
Additionally, the new UpdateJobPriorityAsync endpoint provides this same functionality through REST. For more information, see Imaging API (REST).
The new Instance Setting Manager API supports create, read, update, and delete operations on instances setting in a Relativity environment. The methods for these operations are available on the IInstanceSettingManager interface in the Relativity.Services.Interfaces.InstanceSetting namespace. The response and request classes, and the enumeration supporting this functionality are available in the Relativity.Services.Interfaces.InstanceSetting.Model namespace. For more information, see Instance Setting Manager (.NET).
Additionally, the Instance Setting Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Instance Setting Manager (REST).
The Message of the Day API now includes the following enhancements and general updates:
The Object Manager API now includes the new UpdateLongTextFromStreamAsync() method for updating a single long text field that exceeds the length limits of an HTTP request. An instance of the new UpdateLongTextFromStreamRequest class is passed to this method as a parameter. The new method is available in the Relativity.Services.Object namespace, and the new class is available in the Relativity.Services.Objects.DataContracts namespace. For more information, see Object Manager (.NET).
Additionally, the new updatelongtextfromstream endpoint provides this same functionality through REST. For more information, see Object Manager (REST).
The Processing API now includes the following new methods:
These methods are available on the new IProcessingFilterManager interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. For more information, see Processing Filter Manager.
Additionally, the new methods are available through REST and provide the same functionality as available through .NET. For more information, see Processing Filter Manager (REST).
Note: The Processing Filters Manager API is a preview release, which will continue to undergo contract changes in future releases.
The Production API now supports canceling multiple production jobs with a single method call. It also includes updates to the method for canceling a single production job. The following list highlights these updates:
Note: In the Relativity
For C# codes sample and additional information, see Production Manager (.NET) under the Services API.
Through REST, the Production Manager service also includes the new MassCancelAsync endpoint for canceling multiple production jobs. The CancelJobAsync endpoint now uses an updated format for the JSON request. For more information, see Production Manager (REST).
Note: In the Relativity
Relativity Forms API updates now provide more flexibility around Yes/No field behavior and sorting behavior on drop down lists. For more information, see Relativity Forms API.
The SourceProvider class is now in the kCura.IntegrationPoints.Contracts namespace in the kCura.IntegrationPoints.Contracts.dll. Previously, this class was in the kCura.IntegrationPoints.SourceProviderInstaller namespace. Other updates include the addition of a new assembly called kCura.IntegrationPoints.Services.Interfaces.Private.dll, and the removal of unnecessary DLLs from the SDK. For more information, see Relativity Integration Points.
Note: For compatibility with
The 64-bit SDK installers have been updated for the
Note: Contact Client Services if you need an older version of an SDK.
The new Review API is a suite of APIs that you can use to build and maintain Review integrations. Review is an updated Relativity document review application that you can use to review, annotate, and code documents in a workspace. It offers performance and extensibility improvements over the current HTML viewer. The Review API supports the extensibility of Review by providing JavaScript classes and functions. For more information, see Relativity Review API.
The Relativity Forms API now includes the following enhancements and general updates:
For more information, see Relativity Forms API.
The new View Fields Manager API allows you to view the relation between the Artifact IDs of View Fields objects and the Artifact IDs of a production. The new RetrieveViewFieldIDsFromProductionAsync() method is available on the IViewFieldManager interface. For more information, see Field Manager (.NET).
Additionally, the View Fields Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Field Manager (REST).
The following enhancements are available in the
The Agent Manager API now includes the following enhancements and general updates:
These methods and classes are available in the Relativity.Services.Interfaces.Agent and Relativity.Services.Interfaces.Agent.Models namespaces respectively.
Additionally, the Agent Manager service also supports the ability to add multiple agents to Relativity in a single call through REST.
Note: For compatibility with
The new Keyboard Shortcuts Manager API includes the overloaded GetKeyboardShortcuts() method, which retrieves all keyboard shortcuts available in a workspace, or a specific subset of them, such as those assigned to the system, choices, or fields. This method is available on the IKeyboardShortcutsManager interface in the Relativity.Services.KeyboardShortcuts namespace. The Relativity.Services.KeyboardShortcuts.Models namespace contains the KeyboardShortcutsRequest and other classes used to support this method. For more information, see Keyboard Shortcuts Manager (.NET).
Additionally, the Keyboard Shortcuts Manager service exposes the GetKeyboardShortcuts endpoint that supports this same functionality through REST. For more information, see Keyword Search Manager (REST) for saved searches.
In the List Page Interaction Event Handler API, the New Item Button API now includes the new buttonApi.getButtons(). This method returns an array of button objects. For more information, see List Page Interaction Event Handler API.
The new Object Type Manager API exposes methods for programmatically working with custom object types implemented in your applications. It supports create, read, update, and delete operations on object types. To simplify creating and deleting object types, it provides helper methods for retrieving parent object types and dependent objects. These methods are available on the new IObjectTypeManager interface in the Relativity.Services.Interfaces.ObjectType namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.ObjectType.Models namespace of the Services API.
The following APIs provide functionality for working with event handlers, object rules, and mass operations for object types:
Additionally, the Object Type Manager, Event Handler Manager, and Object Rule Manager services expose endpoints through REST that provide the same functionality as available through .NET.
The Processing API now includes a new feature called the Processing Filter Manager API. It exposes methods for programmatically creating, updating, and deleting processing filters. It supports applying these filters to data and retrieving the filtered data. Additionally, this service exposes helper methods for retrieving filters associated with a data source or available in a specific workspace.
These methods are available on the new IProcessingFilterManager interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. For more information, see Processing Filter Manager.
Additionally, the Processing Filter Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Processing Filter Manager (REST).
Note: The Processing Filters Manager API is a preview release, which will continue to undergo contract changes in future releases.
The Production API now supports canceling multiple production jobs with a single method call. It also includes updates to the method for canceling a single production job. The following list highlights these updates:
Note: In the Relativity
For C# codes sample and additional information, see Production Manager (.NET) under the Services API.
Through REST, the Production Manager service also includes the new MassCancelAsync endpoint for canceling multiple production jobs. The CancelJobAsync endpoint now uses an updated format for the JSON request. For more information, see Production Manager (REST).
Note: In the Relativity
Relativity Forms is a new Layout-rendering option and the API documentation has been updated and published so that developers can leverage the robust Javascript APIs and enable more controlled Relativity Object customization. For more information, see Relativity Forms API.
The 64-bit SDK installers have been updated for the
Note: Contact Client Services if you need an older version of an SDK.
The following enhancements are available in the
The new Agent Manager API exposes multiple operations for programmatically managing agents in your Relativity environment. It supports create, read, update, and delete operations on agents. To simplify your workflows, it provides helper methods for retrieving agent types and agent servers. The Agent Manager API also includes validation methods used to check whether a create, update, or delete operation violates the maximum or minimum number of required agents for a Relativity environment, server, or resource pool. These methods are available on the new IAgentManager interface in the Relativity.Services.Interfaces.Agent namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.Agent.Models namespace of the Services API.
Additionally, the Agent Manager service exposes endpoints through REST that provide the same functionality as available through .NET.
The Document Viewer Services API now supports converting files contained in File fields on a Relativity Dynamic Objects (RDOs) for display in the standalone viewer. These files are converted to their native format on the fly. The following list highlights updates to this API:
The Document Viewer Services API is available in the Relativity.DocumentViewer.Services namespace. The GetViewerContentKeyAsync endpoint also supports this new functionality through REST. For more information, see Document Viewer Services (.NET) and Document Viewer Services (REST).
Review the following sections to learn more about enhancements for mass operations and export functionality now available in the Object Manager API.
The Object Manager API now supports the ability to retrieve a list of objects dependent on one or more specific objects selected for deletion. You can use this new functionality to determine whether a delete operation may be blocked by object dependencies, or how other Relativity objects may be affected by deleting a specific object. This functionality is similar to the dependency report available in the Relativity UI.
The following list highlights enhancements for this feature in .NET:
Through the REST API, the Object Manager service also exposes the dependencylist endpoint, which supports the functionality for retrieving a list of dependent objects. For more information and code samples, see Object Manager (.NET) and Object Manager (REST).
The Object Manager API now supports setting and updating values in file fields. This functionality is also available through REST. For more information, see Object Manager (.NET) and Object Manager (REST).
In the Object Manager API, the ReadOptions class now has a new property called FieldTypesToReturnAsString, which returns a list of currency or decimal field types as a string. This functionality is also available through REST. For more information, see Object Manager (.NET) and Object Manager (REST).
In the Processing API, the Entity constant in the CustodianType enumeration has been renamed to Other. The value and description of Other remains unchanged. It continues to have a value of 2, and to represent a corporation, data location, or other construct. The CustodianType enumeration is available in the Relativity.Processing.Services namespace of the Class library reference reference. For general information, see Get started with the Processing API.
Note: You must upgrade any existing code that references the Entity constant. Instead, reference the Other constant in any .NET or JSON used in your custom applications.
The Structured Analytics API supports the new name normalization feature now available in Relativity. This feature simplifies identifying the senders and recipients of email messages, which frequently have multiple aliases assigned to them. It identifies the aliases within email headers, such as a proper name, email address, and other items. It then assigns these aliases to entities that are imported into Relativity and linked to document fields. For more information, see
To support the name normalization feature, the Structured Analytics API includes the following enhancements:
These classes and enumerations are available in the Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status namespace. For more information, see Structured Analytics Job Manager (.NET).
Additionally, the Structured Analytics Manager service also supports the new name normalization feature through REST. For more information, see Structured Analytics Job Manager (REST).
Note: For compatibility with
The new Tab Manager API supports programmatically managing tabs in Relativity. It supports create, read, update, and delete operations on tabs. To simplify working with tabs, it also provides helper methods for retrieving information about the display order of tabs, parent tabs, available object types to associated with tabs, and objects dependent on a specific tab. Additionally, it also supports retrieving workspace-level metadata for admin and system tabs.
The Tab Manager API exposes the methods for interacting with tabs on the ITabManager Interface available in the Relativity.Services.Interfaces.Tab namespace. The classes and enumeration supporting this functionality are available in the Relativity.Services.Interfaces.Tab.Models namespace. For more information, see Tab Manager (.NET).
Additionally, the Tab Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Tab Manager (REST).
The 64-bit SDK installers have been updated for the
Note: Contact Client Services if you need an older version of an SDK.
The following enhancements are available in the
In the Import API, OnProcessProgess event now provides information about the throughput for transferring files and document metadata in bytes per second. This enhancement is the result of the new FilesThroughput and MetadataThroughput properties added to the FullStatus class, which represents status information provided to the OnProcessProgess event. This class is available in the kCura.Relativity.DataReaderClient namespace of the Import API
Review the following sections to learn more about enhancements for mass operations and export functionality now available in the Object Manager API.
The Object Manager API now supports mass operations for creating, updating, and deleting Relativity Dynamic Objects (RDOs). It also supports mass operations for updating and deleting Document objects. For the objects undergoing mass update and delete operations, you have the options to set search conditions, or to specify the identifiers to select objects. The mass update operation provides an additional option for specifying a list of common fields for updating on a group of objects. The objects undergoing a mass operation must all be of the same type.
The following list highlights these enhancements in .NET:
Through the REST API, the Object Manager service supports mass operations with its existing endpoints for update and delete on Document objects and RDOs, and create on RDOs. It does require new JSON request formats for mass operations. The options for progress reporting, and cancellation requests aren't available through REST. For more information and code samples, see Object Manager (.NET) and Object Manager (REST).
Note: For compatibility with
You can now export document fields, including complete long text fields such as extracted text. The export process uses a three-step workflow involving setting up an export job and retrieving successive blocks of document fields. When the amount of text in a field exceeds a specific size limit, you can use streaming to retrieve this data. Additionally, the retrieval methods for export jobs can be run in parallel to achieve high throughput.
The following list highlights export enhancements in .NET:
The Object Manager service also supports the new export functionality through REST. It includes the following new endpoints for this functionality: initializeexportasync, retrievenextresultsblockfromexportasync, and streamlongtextasync. It uses the same export workflow as .NET. For more information and code samples, see Object Manager (.NET) and Object Manager (REST).
In
Note: You don't need to upgrade your current providers due to this enhancement. Legacy providers are compatible with this update to the JavaScript library.
The 64-bit SDK installers have been updated for the
Note: Contact Client Services if you need an older version of an SDK.
On this page
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!
Additional Resources |
|||
DevHelp Community | GitHub | Release Notes | NuGet |