Deprecated functionality
The following information describes functionality that has been deprecated in Relativity:
RelativityOne 12.2.168.12 - July 31, 2021
The following functionality is scheduled for deprecation or has been deprecated.
RelativityOne SDK Installer
As of the Prairie Smoke release, the Relativity SDK MSI installer is no longer available for download. You can obtain the Relativity HTTP APIs by downloading the .NET packages from NuGet, or by using the corresponding REST services.
RelativityOne 12.1.204.3 - April 24, 2021
The following functionality is scheduled for deprecation or has been deprecated.
Imaging API
The Imaging API contains several methods that have been deprecated and replaced with new functionality. The following table lists these methods and their replacements. For more information, see Imaging (.NET).
| Interfaces | Deprecated methods | New methods |
|---|---|---|
| IImagingProfileManager | SaveAsync() |
|
| IImagingSetManager | SaveAsync() |
|
| IApplicationFieldCodeManager | SaveAsync() |
|
Due to the versioning of the Imaging API, all of the endpoints have been updated with a new format that includes versioning information and other changes. For examples of the new URL formats, see Imaging API (REST).
Note: Although the legacy Imaging API continues to be supported in the Osier release, we recommend that you implement any new functionality with the versioned Imaging API. See Imaging (.NET) and Imaging API (REST).
Instance Setting Manager API
In the Instance Setting Manager API, the method signatures on the IInstanceSettingManager interface have been deprecated. They no longer require a workspace ID set to -1 to indicate the admin-level context.
The following table lists the deprecated method signatures and their replacements. For more information, see Instance Setting Manager (.NET).
Invariant API
The Invariant API is now private and no longer available for use in custom applications. You can continue to customize applications using the Processing APIs. For more information, see Processing.
Keyboard Shortcuts Manager API
In the Keyboard Shortcuts Manager API, the overloaded GetKeyboardShortcuts() method has been deprecated. It has been replaced with the new ReadAsync() method on the IKeyboardShortcutsManager interface in the Relativity.Review.Server.Versioned.<VersionNumber>.KeyboardShortcuts namespace. For more information, see Keyboard Shortcuts Manager (.NET).
The legacy endpoint for retrieving keyboard shortcuts through REST has also been deprecated. A new URL for this functionality is now available. For more information, see Keyboard Shortcuts Manager (REST).
Password Bank API
The Password Bank API is now deprecated in RelativityOne.
Tab Manager API
The Tab Manager API contains several methods that have been renamed or deprecated. The following table lists these methods and their replacements. For more information, see Tab Manager (.NET).
| Interface | Deprecated methods | New methods |
|---|---|---|
| ITabManager | GetAvailableObjectTypesAsync() | GetEligibleObjectTypesAsync() |
| ITabManager | GetAvailableParentsAsync() | GetEligibleParentTabsAsync() |
| ITabManager | GetDependencyList() | GetDependencyListAsync() on the Object Manager API |
Due to the versioning of the Tab Manager API, all of the endpoints have been updated with a new format that includes versioning information and the changes in the previous table. For examples of the new URL formats, see Tab Manager (REST).
RelativityOne - January 27, 2021
The following functionality is scheduled for deprecation or has been deprecated.
HTTP headers content types
The HTTP header Content-Type field no longer can be set to application/json;charset/utf-8, or text/json.
RelativityOne 11.3.157.22 - October 24, 2020
The following functionality is scheduled for deprecation or has been deprecated.
Platform Status tab
The Platform Status tab has been deprecated in the RelativityOne Mayapple release.
RelativityOne 11.1.152.1 - March 28, 2020
RelativityOne 11.1.152.1 - March 28, 2020
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.
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
- 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
RelativityOne 11.0.162.34 - January 4, 2020
The following functionality is scheduled for deprecation or has been deprecated.
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 (.NET) and Object Manager (REST).
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);
}
RelativityOne 10.3.170.1 - September 28, 2019
The following functionality is scheduled for deprecation or has been deprecated.
APIs scheduled for deprecation
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).
Import API
The following list includes deprecated features and functionality in the Import API:
- Import API SDK removed from Relativity
- Deprecated the Relativity.Import.Client NuGet package - Beginning with the Relativity
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.
- RelativityVersionMismatchException - This exception is now deprecated. In previous versions, it was thrown from the ImportAPI class constructor when the .NET assembly for the Import API didn’t match the Relativity version.
As of the Goatsbeard release, the new RelativityNotSupportedException replaces the RelativityVersionMismatchException. For more information, see Import API migration.
- Deprecated Import API dependencies on kCura.dll and Relativity.dll assemblies - Because the Import API is decoupled from Relativity core, it no longer has dependencies on the kCura.dll and Relativity.dll assemblies. If your Import API application uses objects from the kCura.dll or Relativity.dll assemblies, add a reference to the Relativity.Other package to continue using these components. For more information, see Import API migration.
- Deprecated kCura.OI.FileID assembly - This assembly is no longer supported for file type identification purposes. You must now use the File Identification API in the Relativity.DataExchange.Io API namespace.
Object Query Manager API
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).
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);
}
RelativityOne 10.2.170.2- June 29, 2019
The following functionality has been deprecated.
Production API
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).
Deprecated functionality in previous versions
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.
