Deprecated functionality in Relativity

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 11.1.152.1 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 RelativityOne 11.1.152.1 and above, update your custom code to use the new namespace names. Additionally, upgrade custom applications by referencing the new DLLs provided for this release. See Download the SDKs and NuGet packages.

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 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);
}

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 API and Object Manager service.

Import API

The following list includes deprecated features and functionality in the Import API:

Import API SDK removed from Relativity One SDK MSI - Beginning with the RelativityOne Goatsbeard release, the Import API is no longer part of the Relativity Services SDK published in the Community. The Import API SDK is available only as a NuGet package called Relativity.DataExchange.Client.SDK. For more information, Get started with the Import API or Import API migration.
Deprecated the Relativity.Import.Client NuGet package - Beginning with the RelativityOne Goatsbeard release, the new NuGet package called Relativity.DataExchange.Client.SDK replaces this legacy Relativity.Import.Client NuGet package. For more information, Get started with the Import API or Import API migration.
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 API and Object Manager service.

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);
}

RelativityOne10.2.170.2 - June 29, 2019

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 API.

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 service.

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.

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