RSAPI deprecation process

This page provides a comprehensive set of communications and guidance to assist you in the process of deprecating the RSAPI. In the coming months, we will update this page to provide advanced notice of how and when we will deprecate the RSAPI.

This page contains the following information:

See this related page:

API Life cycle summary and definition

This list defines the support offered by Relativity as the APIs transition through different phases of the deprecation life cycle.

Life cycle support

The following terms refer to the different phases of the API deprecation life cycle:

  • General Availability - In the General Availability (GA) phase, the API is released and available for use.
  • Deprecated - In the deprecated phase, we no longer recommend using the API. While deprecated classes and methods are still available, they are tagged obsolete because they will be removed in future releases. You shouldn't use them when implementing new code. Additionally, begin upgrading any existing code, so that it no longer references these obsolete classes and methods.
  • Removed - In the removed phase, Relativity no longer exposes the API. Any functionality using the removed API will break.

Deprecation process

When What Details
Server 2021 Release Deprecation Tag Similar to the RelativityOne 11.3 release, we will add obsolete tags to our 2021 Server release codebase. At this point, there will be no impact to customers. 
Downloadable Server Patch (Q3 2021) New Kepler APIs A separate, downloadable Server Patch will be made available to all Server customers in Q3 2021. This patch will include new Kepler APIs like Script Run to help with the transition. 
Server 2023 (TBD) RSAPI Removal RSAPI will be removed from the 2023 release. Exact timing to be announced. 

API migration matrix

The following table contains a timeline for the deprecation of legacy features and links to newer APIs that support similar functionality. The replacement APIs allow code compatibility between Relativity Server and RelativityOne. Although the links in the table will direct you to the API content in the RelativityOne Developer documentation, the content is applicable for replacement APIs released for Relativity Server, such as the APIs released in the Q3 2021 Server Patch.

(You can sort the contents by clicking on a column heading.)

RSAPI  Feature Deprecated in version Removal schedule Replacement .NET service Replacement REST service Replacement release version
Agent Server 2021 Server 2023 Agent Manager API Agent Manager service 10.0
Batch Server 2021 Server 2023 Batches Manager API Batches Manager service 9.5
Batch Set Server 2021 Server 2023 Batch Sets Manager API Batch Sets Manager (REST) Downloadable Server Patch (Q3 2021)
Choice Server 2021 Server 2023 Choice Manager API Choice Manager service Server 2021
Client Server 2021 Server 2023 Client Manager API Client Manager service Downloadable Server Patch (Q3 2021)
Document Server 2021 Server 2023 Document File Manager API

Object Manager (.NET)

Document File Manager service

Object Manager (.REST)

10.3
Error Server 2021 Server 2023 Error Manager API Error Manager service Downloadable Server Patch (Q3 2021)
Field Server 2021 Server 2023 Field Manager API Field Manager service 10.2
File Transfer Server 2021 Server 2023 File Field Manager (.NET)

Object Manager (.NET)

File Field Manager (REST)

Object Manager (.REST)

Import data into Relativity

TBD
Folder Server 2021 Server 2023 Folder Manager API Folder Manager service 9.3
GenerateRelativityAuthenticationToken** Server 2021 Server 2023 Unsupported** Unsupported** N/A
GetAdminChoiceTypes** Server 2021 Server 2023 Unsupported** Unsupported** N/A
GetProcessState** Server 2021 Server 2023 Unsupported** Unsupported** N/A
Group Server 2021 Server 2023 Group Manager API Group Manager service Downloadable Server Patch (Q3 2021)
Instance Setting Server 2021 Server 2023 Instance Setting Manager API Instance Setting Manager service 10.2
Layout Server 2021 Server 2023 Layout Manager API Layout Manager service Downloadable Server Patch (Q3 2021)
Library Application Server 2021 Server 2023 Library Application API Library Application service 10.3
MarkupSet Server 2021 Server 2023 Object Manager API Object Manager service 9.5
Matter Server 2021 Server 2023 Matter Manager API Matter Manager service 10.3
Object Rule Server 2021 Server 2023 Object Type Manager API Object Type Manager service 10.1
ObjectType Server 2021 Server 2023 Object Type Manager API Object Type Manager service 10.1
Productions Server 2021 Server 2023 Production Manager API Production Manager service 9.6
Relativity Application (Workspace Level) Server 2021 Server 2023 Export API Export service Server 2022 (Q1 2022)
Relativity Dynamic Object (RDO) Server 2021 Server 2023 Object Manager API Object Manager service 9.5
Resource File Server 2021 Server 2023 Resource File API Resource File service Server 2022 (Q1 2022)
Resource Pool Server 2021 Server 2023 Resource Pool API Resource Pool service Server 2022 (Q1 2022)
Resource Server Server 2021 Server 2023 Resource Server API Resource Server Service Server 2022 (Q1 2022)
Script Run Server 2021 Server 2023 Script Manager API Script Manager service Server 2021
Script Server 2021 Server 2023 Script Manager API Script Manager service Server 2021
Search Server 2021 Server 2023 **** **** Downloadable Server Patch (Q3 2021)
Search Provider Server 2021 Server 2023 Search Provider API Search Provider service 9.3
Tab Server 2021 Server 2023 Tab Manager API Tab Manager service 10.0
User Server 2021 Server 2023 User Manager API User Manager service Downloadable Server Patch (Q3 2021)
View Server 2021 Server 2023 View Manager API View Manager service 9.6
Workspace Server 2021 Server 2023 Workspace Manager API Workspace Manager service Downloadable Server Patch (Q3 2021)

* New coverage is planned for release and will be available prior to removal.
** This feature is deprecated and will no longer be supported.
*** Preview content. Functionality may not be officially released yet.
**** Documentation will be available soon.

Identifying RSAPI usage

Your code may be relying on RSAPI, even if you are calling Relativity REST services. To determine whether your code is still using RSAPI, you can search for IRSAPIClient in your code if you are calling Relativity .NET APIs, or search for Relativity.REST/Relativity or Relativity.REST/Workspace routes/paths in your code if you are calling Relativity REST endpoints.

Support

For more information about the RSAPI deprecation process, consult the resources below

You can also contact our Developer Experience team or post to DevHelp with questions regarding refactor consultations, code reviews, unsupported features and general questions about Relativity's deprecation strategy.