Deprecated functionality
The following information describes functionality that has been deprecated in Relativity:
Relativity Server Server 2021 - March 24, 2021
The following functionality is scheduled for deprecation or has been deprecated.
Application Install API
Application Install API includes the following deprecated features:
- 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.
- GetAllInstallStatusAsync - endpoint has been removed.
Platform Status tab
The Platform Status tab has been deprecated in the Relativity Server Server 2021 release.
Relativity Integration Points API
Relativity Integration Points includes the following deprecated features:
- JQuery version - jQuery v 3.3.1 has been deprecated and replaced with jQuery v3.4.1. The Relativity Integration Points SDK Server 2021 has been updated with this new jQuery library.
- Renamed namespaces - The namespaces for the Integration Points API have been renamed as follows:
New namespace name Deprecated namespace name Relativity.IntegrationPoints.Contracts kCura.IntegrationPoints.Contracts Relativity.IntegrationPoints.Services.Interfaces.Private kCura.IntegrationPoints.Services.Interfaces.Private Relativity.IntegrationPoints.SourceProviderInstaller kCura.IntegrationPoints.SourceProviderInstaller
Note: For compatibility with
Object Query Manager API
The Object Query Manager API has been deprecated in the Indigo release. Use the query functionality available through the Object Manager API in your custom code. For more information, see Object Manager API and Object Manager service.
Note: Upgrade any existing custom applications calling this Object Query Manager API to ensure they continue to function properly.
Migrating to the Object Manager API
You can easily migrate your existing code to the Object Manager API. The following list outlines the differences between the Object Manager and Query Object Manager APIs:
- With the Object Manager API, you can identify the object types and fields by Name, ArtifactID, and GUID. This functionality was unavailable in the Query Object Manager API.
- With the Object Manager API, you can now use ref object types, which offer several optional properties, rather than just string and integer values.
- The Object Manager API also offers different result formats, such as a QueryResultSet object or a QueryResultSlim object, which contains a smaller payload. See Query for Relativity objects.
Legacy code sample using the Object Query Manager API
The following legacy code queries for the top 25 decimal fields on the Document object type with the Object Query Manager API.
using(var objectQueryManager = Helper.GetServicesManager().CreateProxy<Services.ObjectQuery.IObjectQueryManager>()) { var query = new Services.ObjectQuery.Query() { Condition = "(('Object Type' == 'document') AND ('Field Type' == 'Decimal'))", Fields = new String[] { "Name" }, IncludeIdWindow = false, Sorts = new String[] { "Name ASC" }, }; var includePermissions = new int[] {}; var queryToken = String.Empty; var results = await objectQueryManager.QueryAsync(this.WorkspaceArtifactID, (int) kCura.Relativity.Client.ArtifactType.Field, query, 0, 25, includePermissions, queryToken); }
Updated code sample using the Object Manager API
The following updated code illustrates how to perform the same query as the legacy sample, but it uses the Object Manager API.
using(var objectManager = Helper.GetServicesManager().CreateProxy <Services.Objects.IObjectManager>()) { var nameField = new Services.Objects.DataContracts.FieldRef() { Name = "Name" }; var query = new Services.Objects.DataContracts.QueryRequest() { ObjectType = new Services.Objects.DataContracts.ObjectTypeRef() { ArtifactTypeID = (int) kCura.Relativity.Client.ArtifactType.Field }, Condition = "(('Object Type' == 'document') AND ('Field Type' == 'Decimal'))", Fields = new [] { nameField }, IncludeIDWindow = false, Sorts = new [] { new Services.Objects.DataContracts.Sort() { FieldIdentifier = nameField, Direction = Services.Objects.DataContracts.SortEnum.Ascending } } }; var results = await objectManager.QuerySlimAsync(this.WorkspaceArtifactID, query, 0, 25); }
For full information about deprecated functionality in the previous versions of Relativity, see the Platform change log and the documentation sites for the following versions.
- Deprecated functionality in Relativity 10.3
- Deprecated functionality in Relativity 10.2
- Deprecated functionality in Relativity 9.7
- Deprecated functionality in Relativity 9.6
- Deprecated functionality in Relativity 9.5
- Deprecated functionality in Relativity 9.4
- Deprecated functionality in Relativity 9.3
- Deprecated functionality in Relativity 9.2