RelativityOne Developer News

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.

Coming Soon

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.

Reminders

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.

Released Items

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.

Deprecation of 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.

Deprecation of DataExchange.Client.SDK

The DataExchange.Client.SDK was deprecated in RelativityOne on January 31, 2024. The Relativity.Import.SDK replaces the DataExchange.Client.SDK. See this post in the developer group for more information.

Breaking Change due to deprecation of Send to CaseMap mass operation

2023-11-28
Mass Operations

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.

New developer documentation site

2023-08-28
Documentation

This developer documentation site has been significantly updated to better support Relativity developers. Some noteworthy improvements include:

  • Re-organization of content into three main categories: Explore, Integrate and Extend to more closely align with how you may need to interact with our developer documentation.
  • Added hyperlinks to headings within topics, allowing you to easily copy a hyperlink to a heading within a topic. Mouse-over any heading to display the link image and then click the link image to copy a hyperlink to that heading.
  • Added a topic contents listing on the right-hand side of topics, allowing you to easily see the sections within a topic and quickly jump to the relevant section in that topic. See Basic REST API concepts as an example.
  • Implemented a new approach for displaying reference documentation for .NET assembles, based on real-time retrieval from NuGet. See the topic Relativity Identity .NET API Reference as an example.
  • Implemented a new approach for displaying reference documentation for REST services, based on OpenAPI (OAS) files. See the topic Billing Insights REST API Reference as an example. You can also download OAS files for Rest services to use these in your own development tooling.
  • Improved the API listing table to include links to reference documentation, NuGet packages and OAS files where available. The table is also now filterable and sortable.

Breaking Change due to deprecation of unversioned Production APIs

2023-07-28
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 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.

Breaking Change due to deprecation of unversioned Relativity Audit API

2023-06-01
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.

Breaking Change affecting agents connecting to file shares

2023-06-01
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.

New Billing API

2022-11-30
Billing

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)

Breaking Change affecting DataExchange.Client.SDK

2022-09-30
DataExchange.Client.SDK

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.

OpenID Connect Provider Manager API

2023-02-01
APIs

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

2022-02-26
Agents

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.

RSAPI Deprecation

2022-02-26
RSAPI

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.

Breaking Change affecting Import API

2022-02-15
Import API

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.

Updated Table of Contents

2021-12-01
Documentation

The Table of Contents is re-organized and updated to help you find content more easily.

Deprecated Functionality and Platform Change Log

2021-10-23
RelativityOne Sundrop (12.3)
Documentation

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

2021-10-23
RelativityOne Sundrop (12.3)
Deprecation

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.

Structured Analytics Job Manager API

2021-10-23
RelativityOne Sundrop (12.3)
APIs

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:

  • 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).

Agent Status Manager API

2021-10-1
RelativityOne 12.2.224.7
APIs

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.

Annotations Manager API

2021-07-31
RelativityOne Prairie Smoke (12.2)
APIs

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).

Analytics APIs

2021-04-24
RelativityOne Osier (12.1)
APIs
  • The new Analytics Classification Index .NET API and REST endpoints exposes CRUD operations for working with classification indexes used by the Active Learning application. It also supports submitting, canceling, and checking the statuses of index jobs. For more information, see Analytics Classification Index (.NET). and Batch Sets Manager (REST).
  • The Analytics Conceptual Index API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Analytics.Conceptual.V1.Services. The URLs used through REST also include these updates, as exemplified by conceptual-analytics/v1. For more information, see Analytics Conceptual Index (.NET) and Analytics Conceptual Index (REST).

Audit APIs

2021-04-24
RelativityOne Osier (12.1)
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).

Data Visualization APIs

2021-04-24
RelativityOne Osier (12.1)
APIs
  • The new Layout Manager .NET API and REST endpoints supports programmatically managing layouts in Relativity. It supports create, read, update, and delete operations on layouts. To simplify working with layouts, it also provides a helper method used to retrieve a list of users with permissions necessary to own layouts. For more information, see Layout Manager (.NET) and Layout Manager (REST).
  • 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.ObjectRules. 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).
  • 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. For more information, see Tab Manager (.NET) and Tab Manager (REST). Additionally, the Tab Manager API includes the following new methods on the ITabManager interface:
    • GetEligibleObjectTypesAsync() method - replaces the deprecated GetAvailableObjectTypesAsync() method.
    • GetEligibleParentTabsAsync() method - replaces the deprecated GetAvailableParentsAsync() method.
  • The View Manager API is now versioned. 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)

Document Viewer APIs

2021-04-24
RelativityOne Osier (12.1)
APIs

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. These endpoints are also supported through REST. For more information, see Short Message Viewer Manager (.NET) and Short Message Viewer Manager (REST).

Environment APIs

2021-04-24
RelativityOne Osier (12.1)
APIs
  • The Error Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Environment.V1.Error. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Error Manager (.NET) and Error Manager (REST).
  • 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). Additionally, 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.
  • The Matter Manager API is now versioned. 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).
  • The Resource File API allows clients to manage resource files for the Relativity applications in the environment. It includes support to create, read, update, delete and download resource files, update/upload file content and metadata, and secondary methods that enable the client to read all eligible applications. For more information, see Resource File 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)

Extensibility APIs

2021-04-24
RelativityOne Osier (12.1)
APIs
  • 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).
  • The Script Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Extensibility.V1.Scripts. The URLs used through REST also include these updates, as exemplified by relativity-Extensibility/v1. 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, and clean up script results. For more information, see Script Manager (.NET) and Script Manager (REST)

Identity APIs

2021-04-24
RelativityOne Osier (12.1)
APIs

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:

  • Authentication Provider type API
  • Client Manager API
  • Federated Instance Manager API
  • Group Manager API
  • Login Profile Manager API
  • OAuth2 Client Manager API
  • Permissions API
  • User Manager API

For more information, see Identity (authentication and user accounts).

Imaging APIs

2021-04-24
RelativityOne Osier (12.1)
APIs
The Imaging API is now versioned. 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. For more information, see Imaging (.NET) and Imaging API (REST).

Additionally, the Imaging API and REST service includes the following enhancements:

  • IDocumentStatusManager interface – this new interface contains the GetStatusAsync() method, which retrieves status information about the imaging job for a document.
  • IImagingEnvironmentManager interface - this new 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.
  • New methods to replace the SaveAsync() methods on various interfaces as follows:
    • IImagingProfileManager interface – includes the following new methods: CreateBasicImagingProfileAsync(), CreateNativeImagingProfileAsync(), and UpdateAsync().
    • IImagingSetManager interface – includes the new CreateAsync() and UpdateAsync() methods.
    • IApplicationFieldCodeManager interface - includes the new CreateAsync() and UpdateAsync() methods.

Infrastructure APIs

2021-04-24
RelativityOne Osier (12.1)
APIs

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:

  • Agent Manager API
  • Notifications Manager API
  • Resource Pool/Resource Server APIs

For more information, see Infrastructure.

Object Model APIs

2021-04-24
RelativityOne Osier (12.1)
APIs

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.

Production APIs

2021-04-24
RelativityOne Osier (12.1)
APIs

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:

  • Production Manager API – includes the following new methods described in Production Manager (.NET) and Production Manager (REST):
    • CancelReproductionJobAsync() method - cancels jobs for a re-production.
    • CreateSingleAsync() method - adds a new production set to a Relativity workspace.
    • DeleteSingleAsync() method - removes a production set from Relativity.
    • GetAllAsync() method - retrieves all productions in a workspace.
    • GetProducedProductionsFromDocumentsAsync() method - retrieves produced productions for documents by using document IDs or a mass operation token.
    • GetProductionImagesAsync() method - retrieves information about produced image files.
    • GetProductionImagesTokenAsync() method - retrieves a unique token for paging through images.
    • ProductionRunCheckAsync() method - retrieves document conflicts, production errors, and information about whether the production can be run.
    • ReadSingleAsync() method - retrieves a production set.
    • RerunProductionAsync() method - re-runs a production.
    • RunProductionAsync() method - runs a production job.
    • StageProductionAsync() method - stages a production.
  • Production Data Source Manager API – includes the new GetProductionDataSourceDefaultFieldValues() method that retrieves default field values for a production data source. See Production Data Source Manager (.NET) and Production Data Source Manager (REST).
  • Production Placeholder Manager API - includes the new GetProductionPlaceholderDefaultFieldValues() method that retrieves default field values for a production placeholder. See Production Placeholder Manager (.NET) and Production Placeholder Manager (REST).
  • Production Queue Manager API – this new API exposes methods used to cancel a single or multiple production jobs, to retry multiple jobs, and to set the priority for them. See Production Queue Manager (.NET) and Production Queue Manager (REST).

Review APIs

2021-04-24
RelativityOne Osier (12.1)
APIs
  • 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.<VersionNumber>.BatchSets namespace. For more information, see Batch Sets Manager (.NET). 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 (REST).
  • 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.<VersionNumber>.BatchSets namespace. For more information, see Batches Manager (.NET). Additionally, the Batches Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Batches Manager (REST).
  • The Keyboard Shortcuts Manager API is now versioned. 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. For more information, see Keyboard Shortcuts Manager (.NET) and Keyboard Shortcuts Manager (REST). Additionally, this API now exposes only the ReadAsync() method for retrieving keyboard shortcuts. Through REST, it also now exposes a single endpoint for this purpose as well.