Feedback
Platform change log (Archive)
This change log represents changes before 2020-01-01 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 version release notes.
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 since 2022-01-01, please refer to the Platform change log
Showing 1 to 25 of 526 entries
| Date | Release | Type | Feature | Change |
|---|---|---|---|---|
| Date | Release | Type | Feature | Change |
| 2021-12-20 | 12.3.149.23 | Enhancement | Automated Workflows API | The new Automated Workflows API supports programmatically registering actions, registering triggers, and sending triggers. For more information, see Automated workflows. |
| 2021-10-23 | 12.3.149.23 | Enhancement | Structured Analytics Job Manager API |
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 CancelAndWaitAsync() method and related endpoint in REST are no longer supported. The GetStatusAsync method and related endpoint in REST are now used to check the status of a structured analytics set. The ProgressReport object is no longer supported as a parameter on any methods. For more information, see Structured Analytics Job Manager (.NET) and Structured Analytics Job Manager (REST). |
| 2021-10-01 | 12.2.224.7 | Enhancement | Agent Status Manager API | 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. |
| 2021-07-31 | 12.2.168.12 | Deprecation | RelativityOne SDK | As of the Prairie Smoke release, the Relativity SDK MSI installer is no longer available for download. You can obtain the Relativity HTTP APIs by downloading the .NET packages from NuGet, or by using the corresponding REST services |
| 2021-03-24 | Server 2021 | Breaking Change | Application Install API | The Application Install API includes multiple property enhancements. Three new properties have been added: Details, IsOutOfDate, and ApplicationInstallDetail.Message.
- ConflictCorrelationID: The conflict correlation ID is no longer required when submitting resolutions. It has been removed to clean up the contract. - Options: Use the new ResolutionOptions property instead. - RenameField: Use the Rename enumeration value instead. - ArtifactStatus: The ApplicationInstallDetail.ArtifactStatus property has been replaced with ApplicationInstallDetail.Message. - ResolutionType: The ResolutionType property has been removed. The Application Install API includes multiple endpoint enhancements: - GetAllInstallStatusAsync: endpoint has been removed. - A new endpoint GetAvailableWorkspacesAsync has been added. - The endpoints SearchAsync and SearchApplicationAsync have been modified to include a flag called "includeActions". The route for these endpoints have been slightly modified to reflect the addition of this new flag. For more information, see Application Install API. |
| 2021-03-24 | Server 2021 | Enhancement | Library Application API | The Library Application API includes the following enhancements. The property ApplicationGUID has been added, which contains the GUID of the application contained in the package, used to validate Update workflow. Additionally, the property LicenseStatus has been added, which determines the license status of a specified application: NotApplicable, Valid, Expired, or Invalid. For more information, see Library Application API. |
| 2021-03-24 | Server 2021 | Breaking Change | Relativity Integration Points API | The Relativity Integration Points API includes now uses jQuery v3.4.1 rather than the previous version 3.3.1. The Integration Points SDK has been updated with this new library.
Namespace changes: - kCura.IntegrationPoints.Contracts is now Relativity.IntegrationPoints.Contracts - kCura.IntegrationPoints.Services.Interfaces.Private is now Relativity.IntegrationPoints.Services.Interfaces.Private - kCura.IntegrationPoints.SourceProviderInstaller is now Relativity.IntegrationPoints.SourceProviderInstaller For compatibility with For more information, see Relativity Integration Points. |
| 2021-03-24 | Server 2021 | Enhancement | Object Manager API | The Object Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.ObjectManager.V1 |
| 2021-03-24 | Server 2021 | Enhancement | Processing API | The Processing API includes the following new methods:
- The GetSummaryDataAsync method retrieves the processing set summary data in a specific workspace to display to console, such as environment errors, discover and publish status, and more. - The ValidDeleteAsync method checks if the specified processing data source is safe to be deleted. 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. |
| 2021-03-24 | Server 2021 | Enhancement | Production API | The Production API now includes the MassRetryAsync() method, which is available in the Relativity.Productions.Services namespace. Withe the MassRetryAsync() method, you can retry multiple production jobs in a single call. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 2021-03-24 | Server 2021 | Enhancement | Services API | 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. |
| 2021-03-24 | Server 2021 | Enhancement | REST API | In the REST API, the Object Rule Manager service available as part of the Object Type Manager service includes a new mass delete endpoint that supports removing multiple object rules in a single call. |
| 2021-03-24 | Server 2021 | Enhancement | dtSearch Manager API | The dtSearch Manager API now includes the RunBuildAsync() method, which is available in the Relativity.Compute.dtSearch.Services.Interfaces namespace. With the RunBuildAsync() method, you can run a build that first initiates an incremental dtSearch index build operation, if possible, or else runs a full dtSearch index build operation. Through REST, the dtSearch Manager service also includes this new endpoint. For more information, see dtSearch Manager (.NET) and dtSearch Manager (REST). |
| 2021-03-24 | Server 2021 | Enhancement | Services API | 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. |
| 2021-03-24 | Server 2021 | Enhancement | REST API | The Auth Profile Manager service supports specifying a list of scopes for an OpenID Connect Provider through REST. |
| 2021-03-24 | Server 2021 | Enhancement | REST API |
The Processing API now includes the GetSummaryDataAsync() method that retrieves processing set summary data in a specific workspace to display to console, such as environment errors, discover and publish status, and more. The ValidDeleteAsync() method is also included in the Processing API. The method checks if the specified processing data source is safe to be deleted.
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. Additionally, the new methods are available through REST. For more information, see Processing API services for REST. |
| 2020-01-20 | 10.3.287.3 | Enhancement | Document Viewer API | The Document Viewer API now returns the status code of 400 - Bad Request instead of a 500 - Internal Server Error for various issues. For guidelines about API errors, see API error handling. |
| 2020-01-20 | 10.3.287.3 | Enhancement | Object Manager API | The Object Manager API now returns the status codes of 503 - Temporarily Unavailable, 400 - Bad Request, or 422- Unprocessable Entity instead of a 500 - Internal Server Error for a given issue. For guidelines about API errors, see API error handling. |
| 2020-01-20 | 10.3.287.3 | Enhancement | View Manager API | The View Manager API now returns the status code of 404 - Not Found instead of a 500 - Internal Server Error when the caller doesn't have permissions to a resource. For guidelines about API errors, see API error handling. |
| 2020-01-20 | 10.3.287.3 | Enhancement | Relativity Dynamic Objects | 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. |
| 2020-01-20 | 10.3.287.3 | Enhancement | Document Viewer Services 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. |
| 2020-01-20 | 10.3.287.3 | Enhancement | REST API | As part of the Object Type Manager service, the Object Rule Manager service includes the updated Available Associated Objects endpoint, which now returns a JSON response that contains a ListType field. This field indicates type of associative objects that the list contains, including ChildObject, MultipleObjectField, or SingleObjectField. The updated Read endpoint now returns a JSON response that also contains a SubListObject field. |
| 2020-01-20 | 10.3.287.3 | Enhancement | Services API | As part of the Object Type Manager API, the Object Rule Manager API includes the updated GetAvailableAssociatedObjectsAsync() method, which returns a list of SubListObjectIdentifier objects. The ObjectRuleResponse class now has a new SubListObject property, which gets or sets a SubListObjectIdentifier object. The new SubListObjectIdentifier class represents a DTO containing information that identifies the type of a sub-list object. The new ListType Enumeration indicates the available types of associated objects in a list, including ChildObject, MultipleObjectField, or SingleObjectField. These updates are available in the Relativity.Services.Interfaces.ObjectRules namespace and Relativity.Services.Interfaces.ObjectRules.Models namespace. |
| 2020-01-20 | 10.3.287.3 | Enhancement | Kepler framework | 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. |
| 2020-01-20 | 10.3.287.3 | Enhancement | API Explorer | 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 API Explorer is available as a downloadable RAP file on the Relativity App Hub, which you can install in your Relativity development environment. |
