Platform change log

The Instance Setting Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Services.Environment.V1.InstanceSetting. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Instance Setting Manager (.NET) and Instance Setting Manager (REST).

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.

Script Manager is now updated to use versioned namespace paths. The namespace has been updated to include the business domain and version number as exemplified by Extensibility.v1.Scripts. The ID parameter in various methods was renamed to Identifier. Additionally, this API contains the following new methods that allow you to:

• Queue a script to run
• Retrieve status of a script
• Query action results
• Export action results
• Export script report
• Clean up script results

For more information, see Script Manager (.NET) and Script Manager (REST).

Error Manager is now updated to use versioned namespace paths. The namespace has been updated to include the business domain and version number as exemplified by Environment.V1.Error. This API allows you to expose a single endpoint for creating errors.

For more information, see Error Manager (.NET) and Error Manager (REST).

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 more information, see Tab Manager (.NET).

The Imaging API contains several methods that have been deprecated and replaced with new functionality. The following table lists these methods and their replacements.

The Imaging API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Imaging.Services.Interfaces.V1. The URLs used through REST also include these updates, as exemplified by relativity-imaging/v1.

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

The new IDocumentStatusManager interface contains the GetStatusAsync() method, which retrieves status information about the imaging job for a document. The IImagingEnvironmentManager interface contains the CleanupInactiveJobsAsync() method for cleaning up inactive imaging jobs, and the GetMaxMassImagingJobSizeAsync() method for retrieving the size of a mass imaging job. IImagingJobManager interface includes the new MassImageDocumentsByMassProcessIdAsync(), which submits a mass imaging job. These enhancements are also available through the REST services.

For more information, see Imaging (.NET) and Imaging API (REST).

The Keyboard Shortcuts Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Review.Server.Versioned.V1.KeyboardShortcuts. The URLs used through REST also include these updates, as exemplified by relativity-review/v1. This API now exposes only the ReadAsync() method for retrieving keyboard shortcuts. Through REST, it also now exposes a single endpoint for this purpose.

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.

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 (.NET) and Keyboard Shortcuts Manager (REST).

The Resource File API allows clients to manage resource files for the Relativity applications in the environment. It includes the following features:

• Supports create, read, update, delete and download resource files.
• Update/upload file content and metadata.
• Secondary methods allows the client to read all eligible applications.

For more information, see Resource File API.

The ARM API supports multiple operations required to archive, restore, and move Relativity workspace data. You can also use to view information on currently running ARM jobs or to list available workspaces or ARM archives. For more information, see ARM API.

The Application Install API includes multiple property enhancements. Three new properties have been added: Details, IsOutOfDate, and ApplicationInstallDetail.Message.

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

The Application Install API includes multiple endpoint enhancements:

• GetAllInstallStatusAsync - endpoint has been removed.
• A new endpoint GetAvailableWorkspacesAsync has been added.
• The endpoints SearchAsync and SearchApplicationAsync have been modified to include a flag called "includeActions". The route for these endpoints have been slightly modified to reflect the addition of this new flag.

For more information, see Application Install API.

The Relativity Integration Points API includes now uses jQuery v3.4.1 rather than the previous version 3.3.1. The Integration Points SDK has been updated with this new library.

Namespace changes:

• kCura.IntegrationPoints.Contracts is now Relativity.IntegrationPoints.Contracts
• kkCura.IntegrationPoints.Services.Interfaces.Private is now Relativity.IntegrationPoints.Services.Interfaces.Private
• and kCura.IntegrationPoints.SourceProviderInstaller is now Relativity.IntegrationPoints.SourceProviderInstaller

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.

For more information, see Get started with integration points.

Object Manager API

The Object Manager API is now a versioned API. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.ObjectManager.V1

Processing API

The Processing API includes the following new methods:

The GetSummaryDataAsync method retrieves the processing set summary data in a specific workspace to display to console, such as environment errors, discover and publish status, and more.

The ValidDeleteAsync method checks if the specified processing data source is safe to be deleted.

These methods are available on the IProcessingModule interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. For more information, see Processing API services for REST.

The Production API now includes the MassRetryAsync() method, which is available in the Relativity.Productions.Services namespace. Withe the MassRetryAsync() method, you can retry multiple production error or delete jobs in a single call. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service.

The Processing API now includes the GetSummaryDataAsync() method that retrieves processing set summary data in a specific workspace to display to console, such as environment errors, discover and publish status, and more. The ValidDeleteAsync() method is also included in the Processing API. The method checks if the specified processing data source is safe to be deleted.

These methods are available on the IProcessingModule interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. Additionally, the new methods are available through REST. For more information, see Processing API services for REST.

The new Search Terms Report Services API includes methods to generate a search terms report, adding terms to an existing search terms report, retry any errors, and view the build progress of a specific search terms report. For more information, see Search Terms Report Services API.

Additionally, the new Search Terms Report services expose endpoints that support this same functionality through REST. For more information, see Search Terms Report Services in REST.

The Application Install API now includes this new endpoint:

CancelAllAsync - This endpoint cancels all pending application installs associated with a specified application. For more information, see Application Install API.

• Supports create, read, update, and delete operations and massive operations on choices.
• Provides helper methods used to retrieve choice types and choice servers. Use these methods to determine if a server supports the choice type that you want to add to it.

For more information, see Choice Manager API.

The Library Application API now includes these new endpoints:

• UploadPackageAsync - This endpoint uploads a RAP or XML file to a temporary location in Relativity and returns a unique file identifier along with the meta data for the application. If the file is not in a valid format, a validation exception is thrown. This endpoint is used in conjunction with CreateAsync and UpdateAsync to implement workflows where the application's details need to be displayed for final confirmation before installing the application.
• DownloadPackageAsync - This endpoint downloads a RAP or XML file previously uploaded using the UploadPackageAsync endpoint. It takes the unique file identifier as an argument in the URL path and returns a stream of bytes.
• DeletePackageAsync - This endpoint allows clients to delete an RAP file that has been uploaded to a temporary storage location.

For more information, see Library Application 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).

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:

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

The View Fields Manager API is deprecated and 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. 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:

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

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.

The Import API includes multiple enhancements. The Import API is available only as a NuGet package called Relativity.DataExchange.Client.SDK. The Import API will no longer be part of the Relativity Services SDK published in the Community, but you can easily add the NuGet package to your project through Visual Studio. The Relativity.Import.Client NuGet package has now been deprecated. Any existing Import API applications must now be migrated to the new Relativity.DataExchange.Client.SDK NuGet package. If you don't migrate your applications to this package, they will fail. Additionally, the Import API has a new versioning scheme, so that the package and assembly versions follow Semantic Versioning 2.0.0. The new RelativityNotSupportedException is thrown when the API isn't compatible with the import or export API services provided by Relativity. The Import API is now decoupled from Relativity core, so it no longer has dependencies on these .NET assemblies. If your Import API application uses objects from the kCura.dll or Relativity.dll .NET assemblies, add a reference to the Relativity.Other package to continue using these components. In the Relativity.DataExchange.Client.SDK, this new File Identification API handles the identification of all file types. This API is available in the Relativity.DataExchange.Io API namespace. You must now use the File Identification API because the kCura.OI.FileID assembly is no longer supported. For more information, Get started with the Import API or Import API migration.

• Supports create, read, update, and delete operations on matters.
• Provides helper endpoints used to retrieve available clients and statuses. Use these endpoints to determine the available clients and statuses with which to create or update matters.

For more information, see Matter Manager API.

The Document Viewer Services API now allows you to view information about the persistent highlight sets and terms in a specific document and workspace. The GetPersistentHighlightSets endpoint also supports this functionality through REST. For more information, see Document Viewer Services API and Document Viewer Services in REST.