Feedback
Platform change log
This change log represents changes that may affect Relativity Developers, such as changes to APIs, deprecation of APIs, new APIs and other developer-focused changes. See the User Guide for product release notes.
Upcoming changes
This table describes some upcoming changes that may impact your current solutions. You may need to prepare for these changes before these potentially-breaking changes are released.
This table is not an exhaustive or comprehensive list of all upcoming changes. This table is intended to highlight notable upcoming changes that may have an impact on your current applications. You can also subscribe to the Relativity Developer Group to be notified of upcoming changes.
| Date | Release | Type | Feature | Change |
|---|---|---|---|---|
| 2025-05-13 | 2025-08-29 | Deprecation | Integration Points |
Starting August 29, 2025, the legacy load file workflows, both import and export, will no longer be supported in Integration Points. If you use legacy load file workflows, you will need to begin using alternate APIs by August 29. Import/Export offers similar functionality with additional features such as enhanced field mapping and advanced job status tracking, improved reliability, and a more seamless user experience. As a replacement to Integration Points API, the Transfer API can be used to move data into and from RelativityOne. In addition, Import Service / Export Service APIs can be used for importing or exporting data into and from workspaces: Relativity Transfer SDK,Relativity Import Service,Relativity Export Service. See this post in the developer group for more information. |
| 2025-04-28 | 2025-07-31 | Breaking Change | Classic List Page API |
As previously communicated, Relativity.ListPage has been replaced by Relativity.Lists. Any third-party applications with List Page Interaction Event Handlers for Relativity.ListPage must be updated to provide equivalent event handlers for Relativity.Lists by July 31, 2025. See this post in the developer group for more information, as well as the Classic List Page API deprecation reference page. |
| 2025-04-08 | 2025-06-02 | Deprecation | Lucene Search |
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. |
| 2025-03-28 | 2025-07-18 | Deprecation | Errors tab |
The Errors tab is being deprecated and will be fully removed from RelativityOne instances by July 18, 2025. If you are writing errors to the Errors tab, with scripts or custom code for example, you may need to adjust your script or code to use an alternate error surfacing approach. See this Knowledge Base article and this announcement in the Developer community site for more information.
|
| 2025-03-05 | 2025-06-05 | Deprecation | Collect Folder Path Data | 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. |
| Q4 2022 | TBD | Breaking Change | Classic List Page API | 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. |
Released changes
You can use the following table to find changes for a specific Relativity version, API, or other value. To filter the data in the table, select a value from a drop-down in the column header (Release, Type, and Feature) or type in the Search field. To sort, click the column name. For changes prior to 2022-01-01, please refer to the Platform change log (Archive)
| Date | Release | Type | Feature | Change |
|---|---|---|---|---|
| 2024-03-16 | CI/CD | Deprecation | Audit Metrics API | 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. |
| 2025-02-28 | CI/CD | Breaking Change | Audit API | 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. |
| 2024-12-20 | CI/CD | Deprecation | Analytics Classification API | 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. |
| 2024-12-18 | CI/CD | Enhancement | Usage Report API | The new Usage Report API provides a REST service that modernizes and centralizes the reporting experience across an instance. See Usage Report for more information. |
| 2024-12-06 | CI/CD | Breaking Change | Object Manager REST API | The Object Manager REST API returns a 554 status code if an event handler causes Object Manager's REST API to fail. See this post in the developer group for more information. |
| 2024-12-03 | CI/CD | Deprecation | Data Exchange Client | 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. |
| 2024-07-31 | CI/CD | Deprecation | Solution Snapshot | 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. |
| 2024-09-01 | CI/CD | Breaking Change | RelativityOne Staging | 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. |
| 2024-07-12 | CI/CD | Breaking Change | Relativity.Transfer.SDK | Breaking changes in v2.1.0 of Relativity.Transfer.SDK:
|
| 2024-05-31 | CI/CD | Deprecation | Relativity Testing Framework (RTF) | 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 that the Relativity Testing Framework will continue to be supported for Relativity Server.) |
| 2024-05-20 | CI/CD | Deprecation | API Explorer | 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. |
| 2024-04-26 | CI/CD | Deprecation | Workspace Manager service | The EnableDataGrid field in the Workspace Manager service is now deprecated, and is automatically set to True when creating or updating workspaces. |
| 2024-04-19 | CI/CD | Enhancement | Automated Workflows SDK | In the Automated Workflows service, new parameters were added for action registration, and action definition variables were updated. |
| 2024-04-08 | CI/CD | Enhancement | Relativity Lists API | Relativity Lists API was updated to include Interface: PanelApi |
| 2024-04-08 | CI/CD | Enhancement | Staging Reports API | With the new Staging Reports API you can enumerate folders, generate folder or file reports, retrieve lists of submitted reports, and fetch generated reports as a file. See Staging Reports API for more details. |
| 2024-03-20 | CI/CD | Breaking Change | Object Manager | 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 to 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. |
| 2024-02-01 | CI/CD | Deprecation | Log Extractor | Log Extractor has been updated for a backend change within RelativityOne. The error logs will be extracted from a different data store and will be formatted following the guidelines found on the Log Extractor page. See https://help.relativity.com/RelativityOne/Content/Relativity/Log_Extractor.htm for more details on the changes. |
| 2024-01-31 | CI/CD | Deprecation | Relativity.Transfer.Client |
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. |
| 2024-01-31 | CI/CD | Deprecation | Import API | The Relativity Import API stopped functioning on January 31, 2024 due to migration of data import related products to cloud based solutions. The new version of The Relativity Import API is located here. |
| 2023-11-28 | CI/CD | Deprecation | Mass Operations | The Send to CaseMap mass operation is deprecated in RelativityOne. 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. |
| 2023-08-28 | CI/CD | Enhancement | Documentation | The RelativityOne Developer Documentation site has been significantly updated to better support Relativity developers. See this announcement for more information. |
| 2023-07-28 | CI/CD | Deprecation | Production API | 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 URL, 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. |
| 2023-06-15 | CI/CD | Deprecation | Audit API | 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. |
| 2023-06-01 | CI/CD | Breaking Change | Agents | 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. |
| 2023-04-28 | CI/CD | Enhancement | JavaScript API | Debug functionality added to the JavaScript APIs on Relativity's main window. For more information, see Debug. |
| 2023-04-27 | CI/CD | Enhancement | Legal Hold API | Use the Legal Hold API for interacting with OCR Sets, OCR Profiles, and OCR jobs. Also includes APIs for authorization with Graph API and a public endpoint for getting active custodian details. For more information, see Legal Hold API. |
| 2023-04-25 | CI/CD | Enhancement | Web Import API | Use the Web Import Export API for importing and exporting data into and out of Relativity. For more information, see Web Import Export API. |
| 2023-02-01 | CI/CD | Breaking Change | Production | Added the ability for users to generate Placeholders during the PDF rendering process. Since Placeholders are no longer Productions-specific, the schema is updated to reflect the expanded use case. The following items in the schema will be renamed:
|
| 2023-02-01 | CI/CD | Enhancement | OpenID Connect Provider Manager API | 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). |
| 2022-12-23 | CI/CD | Enhancement | Automated Workflows API | The new Automated Workflows API supports programmatically registering actions and triggers, and sending triggers in the Automated Workflows application. See Automated workflows for more information. |
| 2022-11-30 | CI/CD | Enhancement | Billing API | 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) |
| 2022-09-30 | CI/CD | Breaking Change | Import API SDK | DataExchange.Client.SDK versions lower than 1.17.2 stopped working on 30th of September 2022. This change may impact third-party solutions or applications that use Import API SDK to ingest metadata and documents into RelativityOne. See the post in the developer group for more information. |
| TBD | TBD | Enhancement | OpenID Connect Provider Manager API | 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). |
| 2022-06-30 | 13.1.xxx.x | Deprecation | Relativity Test Helpers | We have officially deprecated and archived the Relativity Test Helpers repo and NuGet packages. Please refer to Testing Custom Applications for alternative approaches. |
| 2022-05-31 | 13.1.xxx.x | Deprecation | Transfer API SDK | Transfer API SDKs version 7.3.12. (and below) stopped functioning on May 31, 2022 due to moving all data transfer related products to cloud based solutions. If your code contains a reference to "Relativity.Transfer", you will need to update your application. In order to keep the continuity of existing custom solutions that utilize Transfer API SDK we recommend to upgrade to the newest version - 7.4.9. It should be seamless and not cause any build troubles as all changes are backward compatible from API standpoint. The newest version of Transfer API SDK is available at https://www.nuget.org/packages/Relativity.Transfer.Client |
| 2022-05-24 | 13.1.xxx.x | Enhancement | Agents | Relativity Agents running on RelativityOne Compute will automatically re-enable themselves if set to a disabled state. These agents will have text in the Note section of the Agent record noting this behavior |
| 2022-03-21 | Server 2022 | Enhancement | Relativity Review API | The Review API and Review Extension framework are now compatible with Relativity Server 2022 (Osier 12.1). For more information, see Review API site. |
| 2022-02-15 | 12.3.149.23 | Deprecation | Import SDK | 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 |
| 2022-01-27 | Enhancement | Relativity Review API | The Review API now includes the new Review Extension framework. For more information, see Review API site. | |
| 2022-03-21 | Server 2022 | Enhancement | Relativity Document Viewer SDK | 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) and creating new documents based on a subset of messages. This versioned API exposes the methods on the IShortMessageViewerManager interface available in the Relativity.DocumentViewer.SDK. The Short Message Viewer Manager service exposes endpoints through REST with the same functionality as available through .NET. For more information, see Short Message Viewer Manager (.NET) and Short Message Viewer Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Audit APIs | 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). |
| 2022-03-21 | Server 2022 | Deprecation | Password Bank API | The Password Bank API is now deprecated. |
| 2022-03-21 | Server 2022 | Enhancement | ObjectModel. SDK |
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. |
| 2022-03-21 | Server 2022 | Enhancement | Infrastructure. SDK |
The APIs within the Infrastructure.SDK 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. For more information, see Infrastructure. |
| 2022-03-21 | Server 2022 | Enhancement | Identity SDK | The APIs within the Identity SDK 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. For more information, see Identity (authentication and user accounts). |
| 2022-03-21 | Server 2022 | Enhancement | Mass Operations Manager API | The Mass Operations Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Extensibility.V1.MassOperations. The URLs used through REST also include these updates, as exemplified by relativity-Extensibility/v1. For more information, see Mass Operation Manager (.NET) and Mass Operation Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Object Rule Manager API | The Object Rule Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by DataVisualization.v1.ObjectRule. The URLs used through REST also include these updates, as exemplified by relativity-data-visualization/v1. For more information, see Object Rule Manager (.NET) and Object Rule Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Workspace Manager API | The Workspace Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Environment.V1.Workspace. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Workspace Manager (.NET) and Workspace Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Instance Setting Manager API | The Instance Setting Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Services.Environment.V1.InstanceSetting. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Instance Setting Manager (.NET) and Instance Setting Manager (REST). Due to the versioning of the Instance Setting Manager API, all of the endpoints have been updated with a new format that includes versioning information and the changes in the previous table. Additionally, the REST URLs have been updated to include the integer for the admin-level context part of the URL In the Instance Setting Manager API, the method signatures on the IInstanceSettingManager interface have been deprecated. They no longer require a workspace ID set to -1 to indicate the admin-level context. Deprecated methods and their replacements: - Task<int> CreateAsync( int workspaceID, InstanceSettingRequest instanceSetting ) replaced with Task<int> CreateAsync(InstanceSettingRequest instanceSetting) - Task DeleteAsync( int workspaceID, int instanceSettingID ) replaced with Task DeleteAsync(int instanceSettingID) - Task<InstanceSettingResponse> ReadAsync( int workspaceID, int instanceSettingID ) replaced with Task<InstanceSettingResponse> ReadAsync(int instanceSettingID) - Task UpdateAsync( int workspaceID, InstanceSettingRequest instanceSetting ) replaced with Task UpdateAsync(InstanceSettingRequest instanceSetting) - Task UpdateAsync( int workspaceID, InstanceSettingRequest instanceSetting, DateTime lastModifiedOn ) replaced with Task UpdateAsync(InstanceSettingRequest instanceSetting, DateTime lastModifiedOn) |
| 2022-03-21 | Server 2022 | Breaking Change | Instance Setting Manager API | In the Instance Setting Manager API, the signatures for all methods on the IInstanceSettingManager interface no longer require a workspace ID set to -1 to indicate the admin-level context. The REST URLs include a similar update that makes the integer for the admin-level context part of the URL. |
| 2022-03-21 | Server 2022 | Enhancement | Tab Manager API | The Tab Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by DataVisualization.v1.Tab. The URLs used through REST also include these updates, as exemplified by relativity-data-visualization/v1. Additionally, new methods include GetEligibleObjectTypesAsync() and GetEligibleParentTabsAsync(). For more information, see Tab Manager (.NET) and Tab Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Script Manager API | Script Manager is now updated to use versioned namespace paths. The namespace has been updated to include the business domain and version number as exemplified by Extensibility.v1.Scripts. The ID parameter in various methods was renamed to Identifier. Additionally, this API contains the following new methods that allow you to:
- Queue a script to run - Retrieve status of a script - Query action results - Export action results - Export script report - Clean up script results For more information, see Script Manager (.NET) and Script Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Error Manager API | Error Manager is now updated to use versioned namespace paths. The namespace has been updated to include the business domain and version number as exemplified by Environment.V1.Error. This API allows you to expose a single endpoint for creating errors. For more information, see Error Manager (.NET) and Error Manager (REST). |
| 2022-03-21 | Server 2022 | Breaking Change | Tab Manager API | The Tab Manager API contains several methods that have been renamed or deprecated.
- ITabManager.GetAvailableObjectTypesAsync() replaced with GetEligibleObjectTypesAsync() - ITabManager.GetAvailableParentsAsync() replaced with GetEligibleParentTabsAsync() - ITabManager.GetDependencyList() replaced with GetDependencyListAsync() on the Object Manager API Due to the versioning of the Tab Manager API, all of the endpoints have been updated with a new format that includes versioning information and the changes in the list above.. For more information, see Tab Manager (.NET). |
| 2022-03-21 | Server 2022 | Enhancement | Production API | 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. Additionally, the Production Manager API includes the following new methods: CancelReproductionJobAsync(), CreateSingleAsync(), DeleteSingleAsync(), GetAllAsync(), GetProductionImagesAsync(), GetProductionImagesTokenAsync(), ReadSingleAsync(), RerunProductionAsync(), RunProductionAsync(), and StageProductionAsync(). The Production Data Source Manager API includes the new GetProductionDataSourceDefaultFieldValues() method. The Production Placeholder Manager API includes the new GetProductionPlaceholderDefaultFieldValues() method. The new Production Queue Manager API exposes methods used to cancel a single or multiple production jobs, to retry multiple jobs, and to set the priority for them. These enhancements are available through .NET and REST. For more information, see Production. |
| 2022-03-21 | Server 2022 | Breaking Change | Imaging API |
The Imaging API contains several methods that have been deprecated and replaced with new functionality. - IImagingProfileManager.SaveAsync() replaced by CreateBasicImagingProfileAsync(), CreateNativeImagingProfileAsync(), UpdateAsync() - IImagingSetManager.SaveAsync() replaced by CreateAsync(), UpdateAsync() - IApplicationFieldCodeManager.SaveAsync() replaced by CreateAsync(), UpdateAsync() The Imaging API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Imaging.Services.Interfaces.V1. The URLs used through REST also include these updates, as exemplified by relativity-imaging/v1. Due to the versioning of the Imaging API, all of the endpoints have been updated with a new format that includes versioning information and other changes. Although the legacy Imaging API continues to be supported in the Osier release, we recommend that you implement any new functionality with the versioned Imaging API. The new IDocumentStatusManager interface contains the GetStatusAsync() method, which retrieves status information about the imaging job for a document. The IImagingEnvironmentManager interface contains the CleanupInactiveJobsAsync() method for cleaning up inactive imaging jobs, and the GetMaxMassImagingJobSizeAsync() method for retrieving the size of a mass imaging job. IImagingJobManager interface includes the new MassImageDocumentsByMassProcessIdAsync(), which submits a mass imaging job. These enhancements are also available through the REST services. For more information, see Imaging (.NET) and Imaging API (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Batches Manager API | The new Batches Manager API supports retrieving information about existing batches, and checking batches in and out. It exposes these methods for interacting with batches on the IBatchesManager interface in the Relativity.Review.Server.Versioned.<Version Number>.BatchSets namespace. Additionally, the Batches Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Batches Manager (.NET). and Batches Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Batch Sets Manager API | The new Batch Sets Manager API exposes CRUD operations for batch sets. It also supports creating and purging batches for a batch set. The Batch Sets Manager API exposes the methods for interacting with batches on the IBatchSetsManager interface in the Relativity.Review.Server.Versioned.<Version Number>.BatchSets namespace. Additionally, the Batch Sets Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Batch Sets Manager (.NET). and Batch Sets Manager (REST). |
| 2022-03-21 | Server 2022 | Breaking Change | Keyboard Shortcuts Manager API | The Keyboard Shortcuts Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Review.Server.Versioned.V1.KeyboardShortcuts. The URLs used through REST also include these updates, as exemplified by relativity-review/v1. This API now exposes only the ReadAsync() method for retrieving keyboard shortcuts. Through REST, it also now exposes a single endpoint for this purpose.
The overloaded GetKeyboardShortcuts() method has been deprecated. It has been replaced with the new ReadAsync() method on the IKeyboardShortcutsManager interface in the Relativity.Review.Server.Versioned.<VersionNumber>.KeyboardShortcuts namespace. The legacy endpoint for retrieving keyboard shortcuts through REST has also been deprecated. A new URL for this functionality is now available. For more information, see Keyboard Shortcuts Manager (.NET) and Keyboard Shortcuts Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Matter Manager API | The Matter Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Environment.V1.Matter. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Matter Manager (.NET) and Matter Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | View Manager API | The View Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.DataVisualization.V1.View. The URLs used through REST also include these updates, as exemplified by relativity-data-visualization/v1. For more information, see View Manager (.NET) and View Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Notifications Manager API | The Notifications Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Infrastructure.V1.Notifications. The URLs used through REST also include these updates, as exemplified by relativity-infrastructure/v1. For more information, see Notifications Manager (MotD) - (.NET) and Notifications Manager (MotD) - (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Layout Manager API | The Layout Manager API supports programmatically managing layouts in Relativity. It supports create, read, update, and delete operations on layouts. It also provides a helper method used to retrieve a list of users with permissions necessary to own layouts. The Layout Manager API exposes the methods for interacting with layouts on the ILayoutManager interface. Additionally, the Layout Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Layout Manager (.NET) and Layout Manager (REST). |
| 2022-03-21 | Server 2022 | Enhancement | Resource File API | The Resource File API allows clients to manage resource files for the Relativity applications in the environment. It includes the following features:
- Supports create, read, update, delete and download resource files. - Update/upload file content and metadata. - Secondary methods allows the client to read all eligible applications. For more information, see Resource File API. |
| 2022-03-21 | Server 2022 | Deprecation | Invariant API | The Invariant API is now private and no longer available for use in custom applications. You can continue to customize applications using the Processing APIs. For more information, see Processing. |
| 2022-03-21 | Server 2022 | Deprecation | HTTP headers content types | The HTTP header Content-Type field no longer can be set to application/json;charset/utf-8 or text/json |
| 2022-03-21 | Server 2022 | Enhancement | ARM API | The ARM API supports multiple operations required to archive, restore, and move Relativity workspace data. You can also use to view information on currently running ARM jobs or to list available workspaces or ARM archives. For more information, see ARM API. |
| 2022-03-21 | Server 2022 | Enhancement | Kepler framework | The Kepler framework now supports the PATCH verb for the HTTP protocol. This feature will continue to undergo enhancements in future releases. For general information, see HTTP headers, verbs, and related information |
| 2022-03-21 | Server 2022 | Deprecation | Services API | The Platform Status tab is now deprecated. |
| 2022-03-21 | Server 2022 | Enhancement | Production API | The Production API now includes the Get ProductionPlaceholderDefaultFieldValues() method. The method is used to retrieve default field values for a new Production Placeholder object. For more information, see Production API. |
| 2022-03-21 | Server 2022 | Enhancement | dtSearch Manager API | 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. The existing CompressIndexAsync method without the activateIndex field will still exist; it will simply call the new CompressIndexAsync() with the value of true for activateIndex. For more information, see dtSearch Manager API. The dtSearch Manager service includes the same update to the CompressIndexAsync() endpoint. |
| 2022-03-21 | Server 2022 | Enhancement | dtSearch Manager service | The dtSearch Manager service includes an update to the CompressIndexAsync() endpoint. The body of the request now includes a new boolean field, activateIndex, which determines if the index is activated after completion of the job. The existing CompressIndexAsync endpoint without the activateIndex field will still exist; it will simply call the new CompressIndexAsync() with the value of true for activateIndex. For more information, see dtSearch Manager Service. |
| 2022-03-21 | Server 2022 | Enhancement | Document Conflicts API | The new Document Conflicts API retrieves information on which documents conflict with a workspace's Production Restrictions search. For more information, see Document Conflicts API. |
| 2022-03-21 | Server 2022 | Enhancement | Library Application API | The Library Application API includes an update to the ReadAsync() and ReadAllAsync() methods. The methods contain a new field, IsGlobalApplication, which represents whether or not the application is a global application. Global applications are applications that cannot be installed into any workspaces. For more information, see Library Application API. |
| 2022-03-21 | Server 2022 | Enhancement | Production API | The Productions API manages productions in a workspace. For more information, see Production API. |
Note: For changes prior to 2022-01-01, please refer to the Platform change log (Archive)
