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.
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.
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
All RSAPI APIs have been deprecated in RelativityOne. For Relativity Server customers, we will provide a specific window for deprecation once we announce our next Server release date. We will be updating this part of the page with more details on timing for this process as they are finalized.
| 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 removal of legacy features, and links to newer APIs that support similar functionality. The replacement APIs allow code compatibility between Relativity Server and RelativityOne.
To sort the contents, click on a table heading.
* 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.
**** API/Service is released, and the 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
- RSAPI migration strategy
- RSAPI Removal Webinar
- Relativity Developer Group for the latest updates
You can also contact our Support team with questions about Relativity's deprecation strategy.
