The following information describes functionality that has been deprecated in Relativity:
The following functionality is scheduled for deprecation or has been deprecated.
The HTTP header Content-Type field no longer can be set to application/json;charset/utf-8, or text/json.
The following functionality is scheduled for deprecation or has been deprecated.
The Platform Status tab has been deprecated in the RelativityOne Mayapple release.
The following functionality is scheduled for deprecation or has been deprecated.
Application Install API includes the following deprecated features:
Relativity Integration Points includes the following deprecated features:
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
The following functionality is scheduled for deprecation or has been deprecated.
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 (.NET) and Object Manager (REST).
Note: Upgrade any existing custom applications calling this Object Query Manager API to ensure they continue to function properly.
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:
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); }
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); }
The following functionality is scheduled for deprecation or has been deprecated.
The View Fields Manager API is scheduled for deprecation in the Relativity Indigo release coming in January 2020:
The View Fields Manager APIs will be removed from the Relativity assemblies. The related documentation will no longer be available in the RelativityOne and Relativity Server Developers sites for the Indigo and higher releases.
Note: Prior to the Indigo release, upgrade any existing custom applications calling this API to ensure they continue to function properly. Consider using similar functionality exposed through the Object Manager API. For more information, see Object Manager (.NET) and Object Manager (REST).
The following list includes deprecated features and functionality in the Import API:
Note: You must migrate to the Relativity.DataExchange.Client.SDK package to ensure that your custom applications continue to function properly. If you don't migrate your applications to the new package, they will fail.
As of the Goatsbeard release, the new RelativityNotSupportedException replaces the RelativityVersionMismatchException. For more information, see Import API migration.
The Object Query Manager API is scheduled for deprecation in the Relativity Indigo release coming in January 2020.
Note: Prior to the Indigo release, upgrade any existing custom applications calling this API to ensure that they continue to function properly. Use the query functionality exposed through the Object Manager API. For more information, see Object Manager (.NET) and Object Manager (REST).
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:
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); }
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); }
The following functionality has been deprecated.
In the Production API, the signature for the CancelJobAsync() method has been updated. The legacy signature of CancelJobAsync(int workspaceArtifactID, int productionArtifactID) is now deprecated. Use the updated CancelJobAsync(ProductionJobRef jobRef) method for any new applications that you want to implement, and for upgrading any existing applications. For more information, see Production Manager (.NET).
Note: The name of the REST endpoint remains CancelJobAsync. However, the format for the JSON request has been updated. For more information, see Production Manager (REST).
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.
Community Updates |
|||
Aero Developer FAQ | Evolving the Platform | Most recent release notes | |
Learn more | Learn more | Learn more |
Additional Resources |
|||
![]() |
![]() |
||
Access Third-Party Tools with GitHub | Create .NET Apps Faster with NuGet | ||
Visit github | visit nuget |