This change log summarizes changes that were made to Relativity APIs in specific versions of Relativity, as well as changes to Relativity features or functionality that might affect how APIs work. It’s designed to help you learn about API changes and find out when those changes occurred. To learn about new features and changes to Relativity development more generally, see What's new for developers in RelativityOne.
You can use the following table to find changes for a specific Relativity version, API, or other value. To filter the data in the table, select a value from a drop-down in the column header (Release, Type, and Feature) or type in the Search field. To sort, click the column name.
| Date | Release | Type | Feature | Change |
|---|---|---|---|---|
| Date | Release | Type | Feature | Change |
| 02/09/2021 | Enhancement | Application Install API | The new Export API allows you to export applications as a RAP file or schema file. For more information, see Export API. | |
| 02/09/2021 | Enhancement | HTTP headers | Relativity REST API standard fields in the HTTP header now includes a Accept-Encoding field to enable automatic response compressing. For more information, see HTTP headers. | |
| 02/09/2021 | Enhancement | Workspace Manager API |
The Workspace Manager API & service is now a versioned API. The namespace has been updated to include the business domain and version number. The URLs used through REST also include these updates. For more information, see Workspace Manager (.NET) and Workspace Manager (REST). |
|
| 10/24/2020 | 11.3.157.22 | Enhancement | ARM 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. |
| 10/24/2020 | 11.3.157.22 | Enhancement | Kepler framework | The Kepler framework now supports the PATCH verb for the HTTP protocol. This feature will continue to undergo enhancements in future releases. For general information, see HTTP headers, verbs, and related information |
| 10/24/2020 | 11.3.157.22 | Deprecated | Services API | The Platform Status tab is now deprecated. For more information, see Deprecated functionality. |
| 10/24/2020 | 11.3.157.22 | Enhancement | Production API | The Production API now includes the Get ProductionPlaceholderDefaultFieldValues() method. The method is used to retrieve default field values for a new Production Placeholder object. For more information, see Production API. |
| 9/10/2020 | 11.2.214.8 | Enhancement | Application Install API | The Application Install API includes an update to the field Version, which has been renamed to SchemaVersion. For more information, see Application Install API. |
| 9/10/2020 | 11.2.214.8 | Enhancement | dtSearch Manger API | The dtSearch Manager API includes an update to the CompressIndexAsync() method. The method contains a new boolean field, activateIndex, which determines if the index is activated after completion of the job. The existing CompressIndexAsync method without the activateIndex field will still exist; it will simply call the new CompressIndexAsync() with the value of true for activateIndex. For more information, see dtSearch Manager API. The dtSearch Manager service includes the same update to the CompressIndexAsync() endpoint. |
| 9/10/2020 | 11.2.214.8 | Enhancement | dtSearch Manger service | The dtSearch Manager service includes an update to the CompressIndexAsync() endpoint. The body of the request now includes a new boolean field, activateIndex, which determines if the index is activated after completion of the job. The existing CompressIndexAsync endpoint without the activateIndex field will still exist; it will simply call the new CompressIndexAsync() with the value of true for activateIndex. For more information, see dtSearch Manager Service. |
| 9/10/2020 | 11.2.214.8 | Enhancement | Library Application API | The Library Application API includes an update to the ReadAsync() and ReadAllAsync() methods. The methods contain a new field, IsGlobalApplication, which represents whether or not the application is a global application. Global applications are applications that cannot be installed into any workspaces. For more information, see Library Application API. |
| 9/10/2020 | 11.2.214.8 | Enhancement | Production API | The Productions API manages productions in a workspace. For more information, see Production API. |
| 3/28/2020 | 11.1.152.1 | Enhancement | Application Install API |
The Application Install API includes multiple property enhancements. Three new properties have been added: Details, IsOutOfDate, and ApplicationInstallDetail.Message. For more information, see Application Install API. Additionally, four properties have been removed: ConflictCorrelationID, Options, ResolutionType, and RenameField. For more information, see Deprecated functionality and Application Install API. The Application Install API also includes multiple endpoint enhancements. The endpoint GetAllInstallStatusAsync has been removed. For more information, see Deprecated functionality and Application Install API. A new endpoint GetAvailableWorkspacesAsync has been added. For more information, see Application Install API. And finally, 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. |
| 3/28/2020 | 11.1.152.1 | Enhancement | Library Application API | The Library Application API includes the following enhancements. The property ApplicationGUID has been added, which contains the GUID of the application contained in the package, used to validate Update workflow. Additionally, the property LicenseStatus has been added, which determines the license status of a specified application: NotApplicable, Valid, Expired, or Invalid. For more information, see Library Application API. |
| 3/28/2020 | 11.1.152.1 | Breaking change | Relativity Integration Points API | The Relativity Integration Points API includes now uses jQuery v3.4.1 rather than the previous version 3.3.1 of this JavaScript library. The Integration Points SDK has been updated with this new library. Additionally, the namespaces for this have been renamed as follows: 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 more information, see Deprecated functionality and Get started with integration points. |
| 3/28/2020 | 11.1.152.1 | Enhancement |
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. |
| 3/28/2020 | 11.1.152.1 | Enhancement | Production API |
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. |
| 3/28/2020 | 11.1.152.1 | Enhancement | Services API | The Object Rule Manager API available through the Object Type Manager API now exposes the new MassDeleteAsync() method, which removes multiple object rules across different object types. Its parameters include the Artifact ID of a workspace and a list containing the Artifact ID for each rule that you want to delete. This method is available on the IObjectRuleManager interface in the Relativity.Services.Interfaces.ObjectRules namespace in the Relativity Services API. For more information, Object Rule Manager API. |
| 3/28/2020 | 11.1.152.1 | Enhancement | REST API | In the REST API, the Object Rule Manager service available as part of the Object Type Manager service includes a new mass delete endpoint that supports removing multiple object rules in a single call. For more information, see Object Rule Manager service. |
| 3/28/2020 | 11.1.152.1 | Enhancement | dtSearch Manager API | The dtSearch Manager API now includes the RunBuildAsync() method, which is available in the Relativity.Compute.dtSearch.Services.Interfaces namespace. With the RunBuildAsync() method, you can run a build that first initiates an incremental dtSearch index build operation, if possible, or else runs a full dtSearch index build operation. Through REST, the dtSearch Manager service also includes this new endpoint. For more information, see dtSearch Manager (.NET) and dtSearch Manager (REST). |
| 3/28/2020 | 11.1.152.1 | Enhancement | Services API | The Auth Profile Manager API now supports specifying scopes for an OpenID Connect Provider. The OpenIdConnectProviders class has the new Scopes property, which is used to specify a list of scopes that a client can request. This class is available in the Relativity.Services.Security.Models namespace in the Relativity Services API. For more information, see Authentication profile. |
| 3/28/2020 | 11.1.152.1 | Enhancement | REST API | The Auth Profile Manager service supports specifying a list of scopes for an OpenID Connect Provider through REST. For more information, see Auth Profile Manager REST service. |
| 3/28/2020 | 11.1.152.1 | Enhancement | REST API |
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. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Document Viewer API | The Document Viewer API now returns the status code of 400 - Bad Request instead of a 500 - Internal Server Error for various issues. For guidelines about API errors, see API error handling. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Object Manager API | The Object Manager API now returns the status codes of 503 - Temporarily Unavailable, 400 - Bad Request, or 422- Unprocessable Entity instead of a 500 - Internal Server Error for a given issue. For guidelines about API errors, see API error handling. |
| 1/4/2020 | 11.0.162.34 | Enhancement | View Manager API | The View Manager API now returns the status code of 404 - Not Found instead of a 500 - Internal Server Error when the caller doesn't have permissions to a resource. For guidelines about API errors, see API error handling. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Relativity Dynamic Objects | You can now define a multiple object field between a RDO and a field object, which means that fields can be set as an associative object type when creating a multiple object field. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Document Viewer Services API | The Document Viewer Services API now allows you to change the default persistent highlight set or terms. Additionally, you can make terms or highlight sets inactive as desired. The SavePersistentHighlightSetState endpoint also supports this functionality through REST. For more information, see the Document Viewer Services API and the Document Viewer Services in REST. |
| 1/4/2020 | 11.0.162.34 | Enhancement | REST API | As part of the Object Type Manager service, the Object Rule Manager service includes the updated Available Associated Objects endpoint, which now returns a JSON response that contains a ListType field. This field indicates type of associative objects that the list contains, including ChildObject, MultipleObjectField, or SingleObjectField. The updated Read endpoint now returns a JSON response that also contains a SubListObject field. For more information, see Object Type Manager (REST). |
| 1/4/2020 | 11.0.162.34 | Enhancement | Services API | As part of the Object Type Manager API, the Object Rule Manager API includes the updated GetAvailableAssociatedObjectsAsync() method, which returns a list of SubListObjectIdentifier objects. The ObjectRuleResponse class now has a new SubListObject property, which gets or sets a SubListObjectIdentifier object. The new SubListObjectIdentifier class represents a DTO containing information that identifies the type of a sub-list object. The new ListType Enumeration indicates the available types of associated objects in a list, including ChildObject, MultipleObjectField, or SingleObjectField. These updates are available in the Relativity.Services.Interfaces.ObjectRules namespace and Relativity.Services.Interfaces.ObjectRules.Models namespace. For more information, see Object Type Manager (.NET). |
| 1/4/2020 | 11.0.162.34 | Enhancement | Kepler framework | With the new Relativity Kepler framework, you can build HTTP services for REST via a .NET interface. You can implement Kepler services using standard .NET contracts, which the framework uses to build HTTP endpoints. Your Kepler service is then deployed in Relativity as part of a custom application built on the Application Deployment System (ADS). Additionally, the Kepler framework includes a client proxy that you can use when interacting with the services through .NET. For more information, see Kepler framework. |
| 1/4/2020 | 11.0.162.34 | Enhancement | API Explorer | The new API Explorer provides an interactive way for you to reference our APIs. It lists our core Relativity REST services, which are organized into modules that you can use to perform CRUDQ operations on a Relativity resource. Each module contains the URLs for service endpoints, the ability to view fields used in the payload request, and information about fields returned in a response. The API Explorer is available as a downloadable RAP file on the Relativity App Hub, which you can install in your Relativity development environment. For more information, see API Explorer. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Search Terms Report API |
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. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Application Install API |
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. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Choice Manager API | The Choice Manager API exposes multiple operations you can use to programmatically manage choices in your Relativity environment. It includes the following features:
For more information, see Choice Manager API. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Library Application API |
The Library Application API now includes these new endpoints:
For more information, see Library Application API. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the GetProductionStatusDetails() method, which is available in the Relativity.Productions.Services namespace. With the GetProductionStatusDetails() method, you can retrieve the status of production jobs, which include details on document count, image count, and several other metrics to indicate the progress. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the GetProductionsEligibleForReproductionAsync() method, which is available in the Relativity.Productions.Services namespace. With the GetProductionsEligibleForReproductionAsync() method, you can retrieve all the productions that can be re-produced based on a mass operation database token corresponding to document artifact IDs. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the CreateReproductionJobAsync() method, which is available in the Relativity.Productions.Services namespace. With the CreateReproductionJobAsync() method, you can create a re-production job and all associated production sets. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the GetReproductionStatusByReproductionJobIDAsync() method, which is available in the Relativity.Productions.Services namespace. With the GetReproductionStatusByReproductionJobIDAsync() method, you can retrieve the status of a re-production job as well as the ArtifactID and Status of productions included in the re-production job. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the GetReproductionJobIDsAsync() method, which is available the Relativity.Productions.Services namespace. With the GetReproductionJobIDsAsync() method, you can retrieve the job ID of every re-production job run in a specified workspace. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the GetProducedProductionsFromDocumentsAsync() method, which is available in the Relativity.Productions.Services namespace. With the GetProducedProductionsFromDocumentsAsync() method, you can retrieve information about productions that have already been produced in a workspace by passing either a list of document Artifact IDs or a mass operation database token corresponding to document Artifact IDs. The endpoints return all productions that have a partial intersection with the list of documents that you passed. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the GetProductionImagesAsync() method, which is available in the Relativity.Productions.Services namespace. With the GetProductionImagesAsync() method, you can retrieve metadata for specific production images within a production in a certain workspace. Through REST, the Production Manager service also includes this new endpoint. For more information, see Production Manager API and Production Manager Service. |
| 1/4/2020 | 11.0.162.34 | Enhancement | Production API | The Production Manager API now includes the MassStageAndRunProductionsAsync() method, which is available in the Relativity.Productions.Services namespace. With the MassStageAndRunProductionsAsync() method, you can stage and run multiple production jobs in the same workspace with 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. |
| 1/4/2020 | 11.0.162.34 | Enhancement | REST API | In REST, the Field Manager service now includes the new availablerelationalorder endpoint. It retrieves information about the order used to display relational field icons in the Related Items pane of the core reviewer interface for a specific workspace. For more information, see Field Manager (REST). |
| 1/4/2020 | 11.0.162.34 | Enhancement | Services API | The Field Manager API now includes the new GetRelationalOrderAsync() method. It retrieves information about the order used to display relational field icons in the Related Items pane of the core reviewer interface for a specific workspace. The new RelationalFieldOrder class is returned by this method, and its properties include the name and type of the relational field, and display order of the field icon. The GetRelationalOrderAsync() method is available on the IFieldManager Interface in the Relativity.Services.Interfaces.Field namespace. The RelationalFieldOrder class is available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET). |
| 9/28/2019 | 10.3.170.1 | Enhancement | Import API | 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. |
| 9/28/2019 | 10.3.170.1 | Enhancement | Relativity Review API | The Goatsbeard release introduces one change to the Relativity Review API. ViewerCollection now raises a vieweractivated event after activating any of its viewers. For more information, see ViewerCollectionEventType enumeration on the Relativity Review API site. |
| 9/28/2019 | 10.3.170.1 | Enhancement | Services API | The Export API available through the Object Manager API now includes the new RetrieveResultsBlockFromExportAsync() method, which retrieves a specific block of document fields from an in-progress export job. The document fields are specified by calling this method with the index ID for a block of records in a batch, the number of records to export, the workspace ID, and the in-progress export ID. This method is available on the IObjectManager interface in the Relativity.Services.Objects namespace. For more information, see Object Manager (.NET). |
| 9/28/2019 | 10.3.170.1 | Enhancement | REST API | The Export service available through the Object Manager service now includes the new RetrieveResultsBlockFromExport endpoint, which retrieves a specific block of document fields from an in-progress export job. The document fields are specified by calling this method with the index ID for a block of records in a batch, the number of records to export, the workspace ID, and the in-progress export ID. For more information, see Object Manager (REST). |
| 9/28/2019 | 10.3.170.1 | Enhancement | Services API | The new Document File Manager API exposes methods for downloading native, image, and produced image files associated with documents in Relativity. You can download a file by specifying its GUID, or you can download a native file by specifying the Artifact ID of the document associated with it. The Document File Manager API also supports retrieving information about these files, such as GUID, name, type, size, and others. These methods are available on the IDocumentFileManager interface in the Relativity.Services.Interfaces.Document namespace. The class and enumerations supporting this functionality are available in the Relativity.Services.Interfaces.Document.Models namespace. For more information, see Document File Manager (.NET). |
| 9/28/2019 | 10.3.170.1 | Enhancement | REST API | Through REST, the new Document File Manager service exposes endpoints for downloading native, image, and produced image files associated with documents in Relativity. You can download a file by specifying its GUID, or you can download a native file by specifying the Artifact ID of the document associated with it. The Document File Manager API also supports retrieving information about these files, such as GUID, name, type, size, and others. For more information, see Document File Manager (REST). |
| 9/28/2019 | 10.3.170.1 | Enhancement | Application Install API | The Application Install API allows clients to install applications into one or more workspaces, cancel pending installations, as well as get the status of any specified application installations. Additionally, this API allows support for conflict resolution for any failed application installations. For more information, see Application Install API. |
| 9/28/2019 | 10.3.170.1 | Enhancement | Processing API | The Processing API now includes the new PivotOnDiscoveredDocumentsAsync method that retrieves discovered documents on pivot in a specific workspace. These methods are available on the new IProcessingFilterManager 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 and provide the same functionality as available through .NET. For more information, see Processing Filter Manager (.NET) and Processing Filter Manager (REST). |
| 9/28/2019 | 10.3.170.1 | Enhancement | Library Application API | The Library Application API allows clients to read application metadata and RAP files from the library, upload new applications, and update or delete existing applications. For more information, see Library Application API. |
| 9/28/2019 | 10.3.170.1 | Enhancement | Matter Manager API | The Matter Manager service exposes multiple endpoints that you can use to programmatically manage matters in your Relativity environment. It includes the following features:
For more information, see Matter Manager API. |
| 9/28/2019 | 10.3.170.1 | Breaking change | Services API | The Field Manager API now has the new Source property on the FieldResponse class. This property references a FieldSource object, which contains information about mapping the current field to a processing field. The FieldResponse class is available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET). |
| 9/28/2019 | 10.3.170.1 | Breaking change | REST API | In REST, the Field Manager service also now includes the Source field on the JSON response returned by the read endpoint. For more information, see Field Manager (REST). |
| 9/28/2019 | 10.3.170.1 | Enhancement | Tab Manager API | The Tab Manager API now includes several renamed fields with different field types for the TabRequest and TabResponse classes. The TabRequest class modified fields are ObjectType (formerly ObjectArtifactTypeID) and Parent (formerly ParentID). The TabResponse class modified fields are CreatedBy, LastModifiedBy, ObjectType, and Parent. The Tab Manager API also includes new fields on the Parent and ObjectType sub-objects of the Tab object. The new fields on the Parent sub-object include ArtifactID and Guids. The new fields on the ObjectType sub-object include ArtifactTypeID, ArtifactID, Guids, and Name. For additional information, see Tab Manager API and Tab Manager service. |
| 9/28/2019 | 10.3.170.1 | Enhancement | Services API | The View Manager API now allows you to see each view in a workspace for a specific Artifact ID. The new RetrieveAllViewsAsync() method is available on the IViewManager interface. Additionally, the View Manager API also allows you see each view that is associated with a saved search in a workspace. The new RetrieveAllViewsForSearchAsync() method is available on the IViewManager interface. For more information, see View Manager API and View Manager Service. |
| 9/28/2019 | 10.3.170.1 | Enhancement | REST API | The View Manager API now allows you to see each view in a workspace for a specific Artifact ID. Additionally, the View Manager API also allows you see each view that is associated with a saved search in a workspace. For more information, see View Manager API and View Manager Service. |
| 9/28/2019 | 10.3.170.1 | Enhancement | Document Viewer Services 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. |
| 6/29/2019 | 10.2.170.2 | Enhancement | Relativity Review API | The new Relativity Review API is a suite of APIs that you can use to build and maintain Relativity Review integrations. Relativity Review is an updated Relativity document review application that you can use to review, annotate, and code documents in a workspace. It offers performance and extensibility improvements over the current HTML viewer. The Relativity Review API supports the extensibility of Relativity Review by providing JavaScript classes and functions. For more information, see Relativity Review API. |
| 6/29/2019 | 10.2.170.2 | Enhancement | Processing API | The Processing API now includes the new GetDocumentMetadataAsync method that retrieves all metadata fields and values for a specific document and the new GetDiscoveredDocumentsAsync method that retrieves discovered documents in a specific workspace. These methods are available on the new IProcessingFilterManager 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 and provide the same functionality as available through .NET. For more information, see Processing Filter Manager (.NET) and Processing Filter Manager (REST). |
| 6/29/2019 | 10.2.170.2 | Breaking change | Relativity Integration Points API | The SourceProvider class is now in the kCura.IntegrationPoints.Contracts namespace in the kCura.IntegrationPoints.Contracts.dll. Other updates include the addition of a new assembly called kCura.IntegrationPoints.Services.Interfaces.Private.dll, and the removal of unnecessary DLLs from the SDK. For more information, see Get started with integration points. |
| 6/29/2019 | 10.2.170.2 | Enhancement | Services API | The new Field Manager API includes multiple operations for programmatically working with field types supported by Relativity, including multiple choice, fixed length text, date, and other fields. It exposes methods for create, read, update, and delete operations on fields. It also provides helper methods for retrieving available object types, views, keyboard shortcuts, and other information about properties that can be set on fields. These methods are available on the IFieldManager Interface in the Relativity.Services.Interfaces.Field namespace. The classes and enumerations supporting this functionality are available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET). |
| 6/29/2019 | 10.2.170.2 | Enhancement | REST API | Through REST, the new Field Manager service includes multiple operations for programmatically working with field types supported by Relativity, including multiple choice, fixed length text, date, and other fields. It exposes endpoints for create, read, update, and delete operations on fields. It also provides helper endpoints for retrieving available object types, views, keyboard shortcuts, and other information about properties that can be set on fields. For more information, see Field Manager (REST). |
| 6/29/2019 | 10.2.170.2 | Enhancement | Services API | The new Instance Setting Manager API supports create, read, update, and delete operations on instances setting in a Relativity environment. The methods for these operations are available on the IInstanceSettingManager interface in the Relativity.Services.Interfaces.InstanceSetting namespace. The response and request classes, and the enumeration supporting this functionality are available in the Relativity.Services.Interfaces.InstanceSetting.Model namespace. For more information, see Instance Setting Manager (.NET). |
| 6/29/2019 | 10.2.170.2 | Enhancement | REST API | The new Instance Setting Manager sevice supports create, read, update, and delete operations on instances setting in a Relativity environment. This service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Instance Setting Manager (REST). |
| 6/29/2019 | 10.2.170.2 | Enhancement | Imaging API | The Imaging API now supports programmatically updating the priority on an imaging job. The new UpdateJobPriorityAsync() method is available on the IImagingJobManager interface. The Imaging API also includes the new UpdateJobPriorityRequest and UpdateJobPriorityResponse classes. This method and classes are available in the Relativity.Imaging.Services.Interfaces namespace. Additionally, the new UpdateJobPriorityAsync endpoint provides this same functionality through REST. For more information, see Imaging (.NET) and Imaging API (REST). |
| 6/29/2019 | 10.2.170.2 | Breaking change | Document Viewer Services API | In the Document Viewer Services API, the GetViewerContentKeyOptions class now includes a new property called ClientId. This property represents a string value that indicates the client ID of the application caller, such as DocumentViewer.Conversion.PreConvert. Through REST, the Document Viewer Services supports the same functionality. For more information, see Document Viewer Services (REST). |
| 6/29/2019 | 10.2.170.2 | Enhancement | Services API | The Object Manager API includes the new UpdateLongTextFromStreamAsync() method for updating a single long text field that exceeds the length limits of an HTTP request. An instance of the new UpdateLongTextFromStreamRequest class is passed as a parameter to this method. This new method and class are available in the Relativity.Services.Object namespace, and the Relativity.Services.Objects.DataContracts namespace respectively. For more information, see Object Manager (.NET). |
| 6/29/2019 | 10.2.170.2 | Enhancement | REST API | Through the REST API, the Object Manager service includes the new updatelongtextfromstream endpoint for updating a single long text field that exceeds the length limits of an HTTP request. For more information, see Object Manager (REST). |
| 6/29/2019 | 10.2.170.2 | Enhancement | MoTD API | The Message of the Day API now includes the following new methods; DismissMOTDAsync(), HasDismissedMOTDAsync(), and IsTextOnlyMOTDAsync(). For more information, see Notifications Manager API (MotD). |
| 6/29/2019 | 10.2.170.2 | Enhancement | Relativity Forms API | Relativity Forms API updates now provide more flexibility around Yes/No field behavior and sorting behavior on drop down lists. For more information, see Relativity Forms API. |
| 6/29/2019 | 10.2.170.2 | Enhancement | Services API | The new View Fields Manager API allows you to view the relation between the Artifact IDs of View Fields objects and the Artifact IDs of a production. The new RetrieveViewFieldIDsFromProductionAsync() method is available on the IViewFieldManager interface. For more information, see View Fields Manager API and View Fields Manager. |
| 6/29/2019 | 10.2.170.2 | Enhancement | REST API | The new View Fields Manager API allows you to view the relation between the Artifact IDs of View Fields objects and the Artifact IDs of a production. For more information, see View Fields Manager and View Fields Manager API. |
| 6/29/2019 | 10.2.170.2 | Enhancement | Audit APIs | The new Audit APIs in .NET include methods that programmatically revert, retrieve, and search Relativity audit records stored in Elasticsearch. These services support interactions with both instance-level and workspace-level audit records. The following APIs provide methods for this functionality: Audit Metrics API, Audit Revert API, Audit Pivot API, Reviewer Statistics API, Audit Query API, and Audit Object Manager UI API. Additionally, these new Audit services expose endpoints that support the same functionality through REST. For more information, see Audit (.NET) and Audit (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Services API | The new Keyboard Shortcuts Manager API includes the overloaded GetKeyboardShortcuts() method, which retrieves all keyboard shortcuts available in a workspace, or a specific subset of them, such as those assigned to the system, choices, or fields. This method is available on the IKeyboardShortcutsManager interface in the Relativity.Services.KeyboardShortcuts namespace. The Relativity.Services.KeyboardShortcuts.Models namespace contains the KeyboardShortcutsRequest and other classes used to support this method. For more information, see Keyboard Shortcuts Manager (.NET). |
| 3/30/2019 | 10.1.169.1 | Enhancement | REST API | Through the REST API, the new Keyboard Shortcuts Manager service exposes the GetKeyboardShortcuts endpoint, which retrieves all keyboard shortcuts available in a workspace, or a specific subset of them, such as those assigned to system, choices, or fields. For more information, see Keyword Search Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Processing API | The new Processing Filter Manager API exposes methods for programmatically creating, updating, and deleting processing filters. It supports applying these filters to data and retrieving the filtered data. Additionally, this service exposes helper methods for retrieving filters associated with a data source or available in a specific workspace. These methods are available on the new IProcessingFilterManager interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. Additionally, the Processing Filter Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Processing Filter Manager (.NET) and Processing Filter Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Relativity Forms API | The new Relativity Forms is a new Layout-rendering option, providing the developer with robust JavaScript APIs and a granular front-end page life cycle for easier, more controlled Relativity object customization. For more information, see Relativity Forms API. |
| 3/30/2019 | 10.1.169.1 | Enhancement | Services API | The new Object Type Manager API to programmatically create custom object types for use in your applications. It supports create, read, update, and delete operations on object types. To simplify creating and deleting object types, it provides helper methods for retrieving parent object types and dependent objects. The Event Handler Manager API includes methods for attaching event handlers to and removing them from object types. It contains helper methods used for retrieving event handlers available in a workspace, and for retrieving event handlers currently attached to an object type. Additionally, the Object Rule Manager API includes methods for creating, updating, reading, or deleting object rules on an object type. It also provides helper methods for retrieving associative objects, layouts, choices, and choice fields used when creating an object rule. The Mass Operation Manager API includes methods for creating, updating, reading, or deleting mass operations on an object type. It also provides helper methods for retrieving available object types, event handlers, and layouts for use with mass operations. For more information, see Object Type Manager (.NET). |
| 3/30/2019 | 10.1.169.1 | Enhancement | REST API | Through the REST API, the new Object Type Manager service exposes endpoints for programmatically working with custom object types implemented in your applications. It supports create, read, update, and delete operations on object types. To simplify creating and deleting object types, it provides helper endpoints for retrieving parent object types and dependent objects. The Event Handler Manager service includes endpoints for attaching event handlers to and removing them from object types. It contains helper endpoints used for retrieving event handlers available in a workspace, and for retrieving event handlers currently attached to an object type. The Object Rule Manager service includes endpoints for creating, updating, reading, or deleting object rules on an object type. It also provides helper endpoints for retrieving associative objects, layouts, choices, and choice fields used when creating an object rule. The Mass Operation Manager service includes endpoints for creating, updating, reading, or deleting mass operations on an object type. It also provides helper methods for retrieving available object types, event handlers, and layouts for use with mass operations. For more information, see Object Type Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Production API | The Production API includes the new MassCancelAsync() method for canceling multiple production jobs, and an update to the signature of the CancelJobAsync() method. These methods are available on the IProductionManager interface in the Relativity.Productions.Services namespace Additionally, it includes the new ProductionJobRef, CancelJobResult, and MassCancelResult classes available in the Relativity.Productions.Services.Interfaces.DTOs namespace. For more information, see Production Manager (.NET).Through REST, the Production Manager service includes the new MassCancelAsync endpoint for canceling multiple production jobs. The CancelJobAsync endpoint now uses an updated format for the JSON request. For more information, see Production Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Event Handlers | In the List Page Interaction Event Handler API, the New Item Button API now includes the new buttonApi.getButtons(). this method returns an array of button objects. For more information, see List Page Interaction Event Handler API. |
| 3/30/2019 | 10.1.169.1 | Enhancement | REST API | The Agent Manager service now supports the ability to add multiple agents to Relativity in a single call through REST. For more information, see Agent Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Services API | The Agent Manager API now includes a new overloaded version of the CreateAsync() method that supports adding multiple agents to Relativity in a single call. The signature for this method now includes an additional integer parameter, which specifies the number of agents to add. In the AgentInstanceLimitResult class, the type for AgentServer and ResourcePool properties has been updated to Securable<DisplayableObjectIdentifier>. The AgentResponse class now inherits from the DisplayableObjectIdentifier class, and the type for the AgentServer, AgentType, CreatedBy, and LastModifiedBy properties has been updated to Securable<DisplayableObjectIdentifier>. The AgentTypeResponse class now inherits from the DisplayableObjectIdentifier class. These methods and classes are available in the Relativity.Services.Interfaces.Agent and Relativity.Services.Interfaces.Agent.Models namespaces respectively. For more information, see Agent Manager (.NET). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Services API | The new User Information Manager API provides methods for retrieving all users from a workspace or admin-level context. The RetrieveAll() method returns a list of UserInfo objects, which contain the Artifact ID, full name, and email address for each user. The RetrieveUsersBy() methods filters on a list of users with conditions set in a query, and it also supports paging. The interfaces and classes for this services are available in the Relativity.Services.Interfaces.UserInfo and Relativity.Services.Interfaces.UserInfo.Models namespaces. For more information, see User Information Manager (.NET). |
| 3/30/2019 | 10.1.169.1 | Enhancement | REST API | The REST API provides coverage for the new User Information Manager service. This service has the retrieveall endpoint that returns the Artifact ID, full name, and email address for each user in a workspace or admin-level context. It also includes provides the retrieveusersby endpoint, which supports both filtering on the results, and paging. For more information, see User Information Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Enhancement | Services API | The new File Field Manager API exposes a service for uploading and downloading files linked to file fields. For uploads, the overloaded UploadAsync() method supports the use of progress indicators and cancellation tokens. The interface for this service is available in the Relativity.Services.FileField namespace. For more information, see File Field Manager (.NET). |
| 3/30/2019 | 10.1.169.1 | Enhancement | REST API | Through the REST API, the new File Field Manager service has endpoints for uploading and downloading files linked to file fields. For more information, see File Field Manager (REST). |
| 3/30/2019 | 10.1.169.1 | Deprecated | Data Grid | Lucene Search is deprecated as a Search Provider for Index Search in Relativity. |
| 1/5/2019 | 10.0.161.8 | Enhancement | Structured Analytics API | The Structured Analytics API includes multiple enhancements to support the new name normalization feature available in Relativity. The new NameNormalizationStatistics class provides information about the number of aliases in the headers for a group of email messages, and the number of new aliases added to Relativity. The JobResults class has the new NameNormalizationStatistics property, which references a NameNormalizationStatistics object. The JobPhase enumeration has the new ImportingEntityAndAliases enum, which indicates that the alias and entity results from the Analytics engine are being imported to a workspace database. The JobOperation enumeration has the new NameNormalizationId enum, which indicates that a name normalization job is the type of Analytics job currently executing. Additionally, the Structured Analytics Manager service also supports name normalization through REST. For more information, see Structured Analytics (.NET) and Structured Analytics Manager (REST). |
| 1/5/2019 | 10.0.161.8 | Enhancement | Services API | The new Tab Manager API supports programmatically managing tabs in Relativity. It supports create, read, update, and delete operations on tabs. To simplify working with tabs, it also provides helper methods for retrieving information about the display order of tabs, parent tabs, available object types to associated with tabs, and objects dependent on a specific tab. Additionally, it also supports retrieving workspace-level metadata for admin and system tabs. These methods are on the ITabManager Interface available in the Relativity.Services.Interfaces.Tab namespace. The classes and enumeration supporting this functionality are available in the Relativity.Services.Interfaces.Tab.Models namespace. For more information, see Tab Manager (.NET). |
| 1/5/2019 | 10.0.161.8 | Enhancement | REST API | The new Tab Manager server exposes multiple endpoints for programmatically managing tabs in Relativity. It supports create, read, update, and delete operations on tabs. To simplify working with tabs, it also provides endpoints for retrieving information about the display order of tabs, parent tabs, available object types to associated with tabs, and objects dependent on a specific tab. Additionally, it also supports retrieving workspace-level metadata for admin and system tabs. For more information, see Tab Manager (REST). |
| 1/5/2019 | 10.0.161.8 | Enhancement | Services API | The new Agent Manager API exposes multiple operations for programmatically managing agents in your Relativity environment. It supports create, read, update, and delete operations on agents. It provides methods for retrieving agent types and agent servers, and for validating whether a create, update, or delete operation violates the maximum or minimum number of required agents. These methods are available on the new IAgentManager interface in the Relativity.Services.Interfaces.Agent namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.Agent.Models namespace. For more information, see Agent Manager (.NET). |
| 1/5/2019 | 10.0.161.8 | Enhancement | REST API | The new Agent Manager service exposes multiple operations for programmatically managing agents in your Relativity environment. It supports create, read, update, and delete operations on agents. It provides endpoints for retrieving agent types and agent servers, and for validating whether a create, update, or delete operation violates the maximum or minimum number of required agents. For more information, see Agent Manager (REST). |
| 1/5/2019 | 10.0.161.8 | Enhancement | Services API | In the Object Manager API, the ReadOptions class now has a new property called FieldTypesToReturnAsString, which returns a list of currency or decimal field types as a string. For more information, see Object Manager (.NET). |
| 1/5/2019 | 10.0.161.8 | Enhancement | REST API | In the Object Manager service, the ReadOptions class now has a new property called FieldTypesToReturnAsString, which returns a list of currency or decimal field types as a string through REST. For more information, see Object Manager (REST). |
| 1/5/2019 | 10.0.161.8 | Enhancement | Services API | The Object Manager API now supports setting and updating values in file fields. For more information, see Object Manager (.NET). |
| 1/5/2019 | 10.0.161.8 | Enhancement | REST API | The Object Manager service now supports setting and updating values in file fields through REST. For more information, see Object Manager (REST). |
| 1/5/2019 | 10.0.161.8 | Enhancement | Services API | The Object Manager API now supports the ability to retrieve a list of objects dependent on one or more objects selected for deletion. It includes the new GetDependencyListAsync() method that returns a list of dependent objects and is available on the IObjectManager interface in the Relativity.Services.Objects namespace. The new DependencyListByObjectIdentifiersRequest class represents a request for information about dependent objects and is available in the Relativity.Services.Objects.DataContracts namespace. Additionally, the new Dependency class represents an object dependent on a specific object selected for deletion and is available in the Relativity.Services.Interfaces.Shared namespace. For more information, see Object Manager (.NET). |
| 1/5/2019 | 10.0.161.8 | Enhancement | REST API | Through the REST API, the Object Manager service now supports the new dependencylist endpoint used to retrieve a list of objects dependent on one or more objects selected for deletion. For more information, see Object Manager (REST). |
| 1/5/2019 | 10.0.161.8 | Breaking change | Processing API | In the Processing API, the Entity constant in the CustodianType enumeration has been renamed to Other. The value and description of Other remains unchanged. The CustodianType enumeration is available in the Relativity.Processing.Services namespace of the Processing API reference. For general information, see Get started with the Processing API. |
| 1/5/2019 | 10.0.161.8 | Enhancement | Document Viewer Services API | The Document Viewer Services API now supports converting files contained in File fields on a Relativity Dynamic Objects (RDOs) for display in the standalone viewer. The GetViewerContentKeyOptions class includes the new FileId property, which provides the identifier for an RDO with an associated File field. During File field conversion, the DocumentIds property on the GetViewerContentKeyRequest class contains only the FieldArtifactId for the File field. The GetViewerContentKeyAsync endpoint also supports this functionality through REST. For more information, see Document Viewer Services (.NET) and Document Viewer Services (REST). |
| 9/26/2018 | 9.7.99.15 | Enhancement | Services API | The Export API now supports exporting document fields, including complete long text fields such as extracted text. The IObjectManager interface exposes three new methods to support the export workflow. The InitializeExportAsync() sets up an export job; the RetrieveNextResultsBlockFromExportAsync() method retrieves successive blocks of document fields; and the StreamLongTextAsync() method streams text when it exceeds a specific size limit. Additionally, the Relativity.Services.DataContracts.DTOs.Results namespace includes the ExportInitializationResults class used to provide information about data that is ready for export. For more information, see Export API in Object Manager (.NET). |
| 9/26/2018 | 9.7.99.15 | Enhancement | REST API | Through REST, the Export API now supports export functionality. It includes the following new endpoints for this functionality: initializeexportasync, retrievenextresultsblockfromexportasync, and streamlongtextasync. It uses the same export workflow as .NET. For more information, see Export API in Object Manager (REST). |
| 9/26/2018 | 9.7.99.15 | Enhancement | Import API | In the Import API, OnProcessProgess event now provides information about the throughput for transferring files and document metadata in bytes per second. This enhancement is the result of the new FilesThroughput and MetadataThroughput properties added to the FullStatus class, which represents status information provided to the OnProcessProgess event. This class is available in the kCura.Relativity.DataReaderClient namespace of the Import API. For more information, see Import API events. |
| 9/26/2018 | 9.7.99.15 | Enhancement | Services API | The Object Manager API now supports mass operations for creating, updating, and deleting Relativity Dynamic Objects (RDOs). It also supports mass operations for updating and deleting Document objects. In the Relativity.Services.Objects namespace, the IObjectManager interface exposes the new overloaded versions of the CreateAsync(), UpdateAsync(), and DeleteAsync() methods for these operations. Additionally, the Relativity.Services.Objects.DataContracts namespace includes several new classes for making mass operation requests and returning results. For more information, see Object Manager (.NET). |
| 9/26/2018 | 9.7.99.15 | Enhancement | REST API | Through the REST API, the Object Manager service supports mass operations with its existing endpoints for update and delete on Document objects and RDOs, and create on RDOs. It does require new JSON request formats for mass operations. For more information, see Object Manager (REST). |
| 6/30/2018 | 9.6.174.30 | Enhancement | RelativityOne Sandbox |
Sandbox is an add on feature that provides you a dedicated instance for testing customizations and applications in RelativityOne. Sandbox provides the ability to further differentiate and customize your RelativityOne offering, enables you to test your customizations and applications without interrupting your production environment, and prepares your organization for the latest RelativityOne functionality and how it will impact custom applications and integrations Administrators can grant access to Sandbox instances by simply adding users to a Sandbox group in your RelativityOne production instance. Sandbox environments are accessed through Federated instances in the User dropdown. |
| 4/28/2018 | 9.6.110.36 | Breaking change | Imaging API | In the Imaging API, the StopImagingSetAsync() method has been deprecated for use through .NET. Similarly, the StopImagingSetAsync endpoint has been deprecated for use through REST. Upgrade your custom code to use the StopImagingJobAsync method or endpoint for compatibility with RelativityOne 9.6.110.36 and above, and Relativity Server9.6.134.78 and above. For more information, see Imaging (.NET). |
| 4/28/2018 | 9.6.110.36 | Enhancement | Relativity Integration Points API | Relativity Integration Points API now supports secured configurations for data source providers. The new DataSourceProviderConfiguration class includes properties for storing both general and secured configurations set by a user. The method signatures on the IDataSourceProvider interface have been updated to include a DataSourceProviderConfiguration object as a parameter rather than configuration JSON as used in previous releases. For compatibility with RelativityOne 9.6.110.36 and above, upgrade any custom source providers by referencing the new DLLs provided in the Relativity Integration Points SDK 9.6.33.7. For sample code, see Use secured configurations for sensitive information. |
| 4/28/2018 | 9.6.110.36 | Enhancement | Services API | New operators for text conditions have been added to enhance querying for objects, and creating views and saved searches. The TextConditionEnum enumeration includes the new IsLessThanOrEqualTo and IsGreaterThanOrEqualTo members. This enumeration is available in the Relativity.Services namespace. Additionally, the CriteriaConditionEnum enumeration includes the new StartsWith and EndsWith members. This enumeration is available in the Relativity.Services.Search namespace. For more information, see Services API. |
| 4/28/2018 | 9.6.110.36 | Enhancement | API Helpers | Relativity API helpers now provide the InstanceSettingsBundle interface for interacting with instance settings from agents, event handlers, and custom pages. The interface includes synchronous and asynchronous methods for refreshing cached instance settings and reading values of different data types. For more information, see Work with instance settings. |
| 4/28/2018 | 9.6.110.36 | Enhancement | Data Grid Audit API | We have updated the Data Grid Audit API to follow the query pattern of the underlying Object Manager API. You can now use the queryslim endpoint to return a condensed version of the payload to conserve network bandwidth. The request input parameters and response structure have also changed to follow the changes in the Object Manager API. For more information, see Legacy Audit API. |
| 4/28/2018 | 9.6.110.36 | Breaking change | Data Grid Audit API | The query/withdetails endpoint of the Data Grid Audit API has been deprecated. For more information, see Deprecated functionality. |
| 2/3/2018 | 9.6.26.97 | Enhancement | Event Handlers | The new List Page Interaction Event Handler API is a collection of JavaScript APIs, which are now exposed specifically for use with list pages. You can interact with list pages by implementing a ListPageInteractionEventHandler and writing separate JavaScript files that contain custom code. This custom code must use the new List Page Interaction Event Handler API developed specifically for this purpose. For more information, see List Page Interaction event handlers and List Page Interaction Event Handler API. |
| 2/3/2018 | 9.6.26.97 | Enhancement | REST API | The Object Manager service now makes POST method calls for all its endpoints. It also offers the QuerySlim endpoint, which streamlines querying by returning a smaller payload than the Query endpoint. All the URLs for the existing endpoints have been updated. Additionally, the format for the JSON requests now require request objects, and include various changes to the fields. For more information, see What's new for developers in RelativityOne, and Object Manager (REST). |
| 2/3/2018 | 9.6.26.97 | Breaking change | REST API | In the Object Manager service, the URLs for each endpoint have been deprecated, and replaced with ones using a new format. The format for the JSON requests has also been modified, requiring a request object as well as other changes. For more information, see Deprecated functionality and Object Manager (REST). |
| 2/3/2018 | 9.6.26.97 | Enhancement | Services API | The Object Manager API now includes the new Relativity.Services.Objects.DataContracts namespace, which contains the majority of classes and enumerations needed to interact with this service. The new Relativity.Services.Objects.Extensions namespace includes classes that contain methods used for working with hydrated objects, such as Choice, Field, Layout, and RelativityObject types. The new QuerySlimAsync() method streamlines querying by returning a smaller payload then the QueryAsync() method. Additionally, the methods on the IObjectManager interface now have updated signatures that require you to pass a request object for a specific operation. For more information, see What's new for developers in RelativityOne and Object Manager (.NET). |
| 2/3/2018 | 9.6.26.97 | Breaking change | Services API | In the Object Manager API, the Relativity.Services.Objects.Models.WebContent namespace and all of its contents have been deprecated. Multiple classes in the Relativity.Services.Objects.Models and Relativity.Services.Field namespace have also been deprecated. In the Relativity.Services.Objects namespace, all existing method signatures have been deprecated and replaced with new ones that require a request object. For more information, see Deprecated functionality and Object Manager (.NET). |
| 2/3/2018 | 9.6.26.97 | Enhancement | Processing API | The Processing API now includes the new Processing Profile Manager service that supports CRUD operations on processing profiles. The new IProcessingProfileManager interface exposes the SaveAsync(), ReadAsync(), and DeleteAsync() methods. It includes the new ProcessingProfile class, which has multiple properties for specifying numbering, deNISTing, extraction, and deduplication settings. Additional classes and enumerations have been added to support this functionality. For more information, see Get started with the Processing API and Processing API services for REST. |
| 2/3/2018 | 9.6.26.97 | Enhancement | REST API | In the Pivot Manager service, the Pivot profile now includes a toggle that displays or hides a sub-chart containing data. This field controls the display of the sub-chart for the bar, stacked, and line charts. For more information, see Pivot Manager (REST). |
| 2/3/2018 | 9.6.26.97 | Enhancement | Services API | In the Pivot API, the Pivot profile now includes a toggle that displays or hides a sub-chart containing data. The ToggleOptions class includes the new ShowSubChart property, which you can set on a PivotProfile object. It controls the display of the sub-chart for the bar, stacked, and line charts. The ToggleOptions class is available in the Relativity.Services.PivotProfile namespace. For more information, see Pivot Manager (REST). |
| 1/6/2018 | 9.5.378.15 | Enhancement | Imaging API | The Imaging API now includes the new ImageDocumentAsync() method, which is used to image a single document on the fly. It takes an instance of the new ImageDocumentJob class, which contains the properties for the workspace, document, and profile IDs. The Imaging API also includes the new StopImagingJobAsync() method, which is used cancel any type of imaging job, including imaging set jobs and jobs for imaging on the fly. The new StopImagingJobRequest and StopImagingJobResponse classes interact with the StopImagingJobAsync() method. The Imaging API services available through REST also support the new ImageDocumentAsync and StopImagingJobAsync endpoints. For more information, see Imaging (.NET) and Imaging API (REST). |
| 12/2/2017 | 9.5.350.16 |
Enhancement | Structured Analytics API | The Structured Analytics API now includes the new RunAsync() method used to execute an analysis; the RunAnalysisPreparationAsync() method used to generate fields before running an analysis; the GetValidTasksAsync() method used to retrieve valid operations for a structured analytics set; the RunCopyToLegacyAsync() method used to copy results to legacy document fields; and the CancelCopyToLegacyAsync() method used to cancel a copy operation. It includes the new AnalysisSettings class used to represent a configuration for running an analysis; the ValidTaskResult class used to represent valid operations for a structured analytics set; and the OperationState class used to provide information about an operation status. In addition, it includes the new StructuredAnalyticsTask enumeration, which contains members used to represent valid operations for a set. For more information, see Structured Analytics (.NET) and Structured Analytics Manager (REST). |
| 12/2/2017 | 9.5.350.16 | Breaking change | Structured Analytics API | In the Structured Analytics API, the RunFullAsync() and the RunIncrementalAsync() methods have been deprecated. The RunAsync() method replaces these deprecated methods for running an analysis of a structured analytics set. In addition, the ExecutionOperation enumeration has been deprecated. The new StructuredAnalyticsTask enumeration now replaces it. For more information, see Deprecated functionality. |
| 12/2/2017 | 9.5.350.16 | Enhancement | Imaging API | The new Imaging API supports programmatically executing imaging jobs in Relativity. It includes the imaging job service, which you can use to run, cancel, and retry imaging jobs. The Imaging API provides services for imaging profiles, imaging sets, and application field codes that support all CRUD operations. The imaging set service offers additional functionality used to hide and release images during a quality control review, while the native type service includes functionality for reading native file types supported by Relativity. It also exposes endpoints through REST that support the same functionality as available in .NET. For more information, see Imaging (.NET) and Imaging API (REST). |
| 10/28/2017 | 9.5.315.50 | Breaking change | Application Deployment System | To improve system security, we have made changes to the way the Relativity HTML sanitizer component parses embedded HTML code in HTML-enabled and custom text fields and labels. |
| 10/28/2017 | 9.5.315.50 | Enhancement | REST API | The View Manager service now supports the functionality for associating a dashboard with a view. When you can create or update a view, you can optionally include a Dashboard object in the JSON request. For more information, see View Manager (REST). |
| 10/28/2017 | 9.5.315.50 | Enhancement | Services API | In the View Manager API, the View class now has a new property called DashboardRef, which is used to associate a dashboard with a view. This property contains the Artifact ID, name, and any GUIDs for the Dashboard instance. This class is available in the Relativity.Services.View namespace. For more information, see View Manager (.NET). |
| 10/28/2017 | 9.5.315.50 | Breaking change | Services API | In the Object Manager API, the QueryAsync() method signature now includes an ObjectTypeRef object rather than an Int32 when referencing an artifact type for a query. This method is available on the IObjectManager interface in the Relativity.Services.Objects namespace. |
| 10/28/2017 | 9.5.315.50 | Breaking change | REST API | On the Object Manager service, the QueryAsync endpoint now requires the JSON request to contain a DescriptorArtifactTypeID or a Guids field set to an identifier for the artifact type that you want to query on. |
| 10/28/2017 | 9.5.315.50 | Enhancement | Services API | The Object Manager service now includes the new DeleteSingleAsync() method, which is used for deleting Document objects and all their associated files, as well as RDOs. The new ObjectDeleteResult class represents the results of a delete operation, and contains a DeleteReport property. The new DeleteReport class provides the results of a delete operation as a collection of DeleteItems objects. The new DeleteItems class contains information about each item removed during a delete operation, such as the type of object deleted, the number of objects, and other details. |
| 10/28/2017 | 9.5.315.50 | Enhancement | REST API | The Object Manager service now includes the DeleteSingleAsync endpoint, which supports deleting Document objects and all their associated files, as well as RDOs. |
| 12/2/2017 | 9.5.350.1 | Enhancement | Document Viewer Services API | The new Document Viewer Services API includes functionality for converting documents to viewer types supported by Relativity, including native, image, production, and transcript types. It includes the GetViewerContentKeyAsync() method that provides this functionality. This method takes a GetViewerContentKeyRequest object that includes information about how to convert a document, such as its conversion type, priority, and other options. The Document Viewer Services API also exposes an endpoint through REST that supports this functionality. For more information, see Document Viewer Services (.NET). |
| 10/28/2017 | 9.5.315.50 | Enhancement | Relativity SDK |
We no longer provide the 32-bit version of the SDK. All custom development for RelativityOne must be performed using the 64-bit version. |
| 10/28/2017 | 9.5.315.50 | Enhancement | Invariant API |
You can now use the DocumentManager RESTful service of the Invariant API to troubleshoot the errors related to the metadata of documents in processing sets. For more information, see DocumentManager service. |
| 9/2/2017 | 9.5.259.2 | Breaking change | Relativity Integration Points API | For the Relativity Integration Points API, the kCura.SourceProviderInstaller.dll file has been renamed to kCura.IntegrationPoints.SourceProviderInstaller.dll. |
| 9/30/2017 | 9.5.287.43 | Enhancement | Field Size API | When interacting with Relativity data, you can now use the RESTful Text Field Size Service to return the size of text in any fixed length or long text field. The API returns the size of the text in UTF-16 bytes, and you don't have to retrieve the contents of the field to calculate it. You can use this functionality to identify documents of a certain size, and use the API to interact with the text in both Data Grid and the Relativity SQL database. For more information, see Field Size API. |
| 9/30/2017 | 9.5.287.43 | Enhancement | Import API | We have significantly improved the performance of the Import API by integrating it with the Relativity Transfer API. The Transfer API queries the target Relativity workspace and, depending on how it is set up, automatically selects an optimal transfer mode: Aspera, direct, or web. Import jobs are now faster, and we have provided additional configuration properties that give you more control of the import and export process. For more information, see Get started with the Import API. |
| 9/30/2017 | 9.5.287.43 | Enhancement | Invariant Monitoring API | You can now use the SetWorkgroupAsync endpoints of the Worker Manager and Job Manager RESTful services of the Invariant API to change the workgroup for workers and jobs. We have added the SetPriorityAsync endpoint to the Job Manager service that enables you to set job priority. You can also use the new RemoveWorkerAsync endpoint of the Worker Manager service to delete processing workers. For more information, see Monitor and troubleshoot processing. |
| 9/30/2017 | 9.5.287.43 | Enhancement | Production API | We have made enhancements to the Production API to allow you to select the production placeholder image format. For more information, see Production Manager (.NET) and Production Data Source Manager (.NET). |
| 9/30/2017 | 9.5.287.43 | Enhancement | Services API | In the Object Query Manager service, the Query class now has a new QueryHint property, which is used to optimize the view. When you call the QueryAsync() method, you can optionally set this property on the Query instance that you pass to this method. The Query class is available in the Relativity.Services.ObjectQuery namespace. For more information, see Legacy Object Query Manager (.NET). |
| 9/30/2017 | 9.5.287.43 | Enhancement | REST API | In the Object Query Manager service, the Query object can now optionally include the QueryHint field in a JSON request on the QueryAync endpoint. The optional QueryHint field is used to optimize the view. For more information, see Legacy Object Query Manager (REST). |
| 9/30/2017 | 9.5.287.43 | Enhancement | Services API | The Object Manager service now includes the new CreateSingleAsync() method, which is used for creating Relativity Dynamic Objects (RDOs) and setting values on their associated fields. The new ObjectCreateResult class represents objects returned by this method. The new Relativity.Services.Objects.Models.WebContent namespace contains classes used to provide event handlers with information about the context in which they are called. Two new overloaded QueryAsync() methods include the options to monitor the progress of a query and to request its cancellation. The Query class now has a new QueryHint property, which is used to optimize the view. The ReadSingleAsync() and UpdateAsync() methods now support identifying fields by name. |
| 9/30/2017 | 9.5.287.43 | Breaking change | Services API | In the Object Manager service, the signatures of the ReadSingleAsync() and UpdateAsync() methods now require a CallingContext object. The Query object can now optionally include the QueryHint field in a JSON request on the QueryAync endpoint. |
| 9/30/2017 | 9.5.287.43 | Breaking change | Services API | The Services API now supports retrieval of Data Grid-enabled fields with Read() and ReadSingle() operations. For more information, see Work with Data Grid, Field code samples, and Single-artifact access. |
| 9/30/2017 | 9.5.287.43 | Breaking change | Services API | The Services API Update() and UpdateSingle() operations with both SQL and Data Grid-enabled fields now generate a single audit record. The oldValue and newValue audit for large text fields are now truncated at 1,000,000 characters for both types of field. For more information, see Work with data grid. |
| 9/30/2017 | 9.5.287.43 | Breaking change | Services API | You can now programmatically associate saved searches with Relativity dashboards. For more information, see Analytics Search Manager (.NET), Legacy dtSearch Manager (.NET), and Keyword Search Manager (.NET). |
| 9/30/2017 | 9.5.287.43 | Enhancement | REST API | The Object Manager service now includes the CreateSingleAsync endpoint, which supports creating Relativity Dynamic Objects (RDOs) and setting values on their associated fields. Additionally, the ReadSingleAsync() and UpdateAsync() endpoints now support identifying fields by name. |
| 9/30/2017 | 9.5.287.43 | Breaking change | REST API | In the Object Manager service, the JSON requests for the ReadSingleAsync() and UpdateAsync() endpoints now require a CallingContext field. |
| 9/30/2017 | 9.5.287.43 | Enhancement | REST API | You can now use the REST API to associate saved searches with dashboards. For more information, see Analytics Search Manager (REST), Legacy dtSearch Manager (REST), and Keyword Search Manager (REST). |
| 9/30/2017 | 9.5.287.43 | Enhancement | Transfer API | We are making the Transfer API (TAPI) available to third-party developers as a technology preview. You can use TAPI to build application components that connect to a Relativity instance and stream the data into Relativity from external data sources using different transfer protocols, for example, HTTP, SMB, and Aspera. You can find the TAPI libraries and documentation in GitHub (https://github.com/relativitydev/transfer-api-samples). |
| 7/29/2017 | 9.5.224.9 | Enhancement | Application Deployment System | We have enhanced the application upgrade process to purge assembly resource files (DLLs) no longer associated to the newer application version. This also removes agent types, event handlers, and application services associated with the application objects. For more information, see Application resource file purge. |
| 7/29/2017 | 9.5.224.9 | Enhancement | REST API | When using the GetFilteredSearchContainerTreeAsync endpoint in the Search Container Manager REST service, you can now specify the saved search tree filtering condition as the object with matching properties, such as created by user, created date, and matching the text in the search and folder names. For more information, see Retrieve expanded search container nodes. |
| 7/29/2017 | 9.5.224.9 | Enhancement | REST API | The Search Container Manager REST service now includes the new GetAdvancedSearchViewInfoAsync, GetAdvancedSearchViewUniqueCreatedByAsync, GetAdvancedSearchViewUniqueModifiedByAsync, and GetAdvancedSearchViewUniqueOwnersAsync endpoints for working with the Advanced Search View fields. For more information, see Retrieve Advanced Search View fieldsKeyword Search Manager (.NET) |
| 7/29/2017 | 9.5.224.9 | Enhancement | Services API | We have added an overloaded to the GetFilteredSearchContainerTreeAsync() method that allows you to specify the saved search tree filtering condition as the SearchContainerTreeFilter object. The condition is a set of object properties, such as created by user, created date, and matching the text in the search and folder names. For more information, see Retrieve expanded search container nodesKeyword Search Manager (.NET) |
| 7/29/2017 | 9.5.224.9 | Enhancement | Services API | The ISearchContainerManager interface provides GetAdvancedSearchViewInfoAsync(), GetAdvancedSearchViewUniqueCreatedByAsync(), GetAdvancedSearchViewUniqueModifiedByAsync(), and GetAdvancedSearchViewUniqueOwnersAsync() methods for working with the Advanced Search View fields.For more information, see Retrieve Advanced Search View fieldsKeyword Search Manager (.NET) |
| 9/30/2017 | 9.5.287.43 | Enhancement | Processing API | The Processing API now includes the new SubmitCancelJobAsync() method and CancelJob class. You can use this method to cancel inventory, discovery, and publishing jobs for a specific processing set. The Processing Services REST API also supports the new SubmitCancelJobAsync endpoint. For more information, see Get started with the Processing API. |
| 7/1/2017 | 9.5.196.101 | Enhancement | Services API | The DefaultFileLocation property of the Workspace DTO now contains a ResourceServer object. You can set it by specifying the resource server ArtifactID as the choice ArtifactID. For more information, see Workspace. |
| 7/1/2017 | 9.5.196.101 | Enhancement | Application Deployment System | The Application Deployment System removes the no longer used event handlers from the associated object types upon application upgrade. For more information, see Advanced functionality for the application framework. |
| 6/29/2017 | 9.5.196.102 | Enhancement | Developer environment setup | You must upgrade your Relativity development environment to .NET 4.6.2. |
| 7/1/2017 | 9.5.196.101 | Enhancement | Analytics Index Manager API |
We have refactored the Analytics Index Manager API to be part of the Analytics application and provide more advanced features for interacting with Analytics indexes. The API now includes the functionality for creating, reading, updating, and deleting indexes, and also retrieving index status and submitting and canceling index jobs. In addition, the Analytics Index Manager API exposes endpoints through REST that provide similar functionality. You must install the Analytics application in your Relativity workspace before you can automate workflows with this API. For more information, see Analytics Index Manager(.NET). |
| 6/29/2017 | 9.5.196.102 | Enhancement | Services API | The Object Manager service supports updating and reading fields on Document objects and Relativity Dynamic objects (RDOs). It also supports querying for Workspaces, Documents, RDOs and system types. These methods are available on the new IObjectManager interface in the Relativity.Services.Objects namespace. Additionally, the new Relativity.Services.Objects.Models namespace contains the following classes used by this service: ObjectUpdateResult, ObjectReadResult, ObjectQueryResultSet, Query, RelativityObject, and EventHandlerStatus classes. The new Relativity.Services.Objects.Exceptions namespace contains the EventHandlerFailedException class. |
| 6/29/2017 | 9.5.196.102 | Enhancement | REST API | The Object Manager service supports updating and reading fields on Document objects and Relativity Dynamic objects (RDOs). The Object Manager service also includes functionality for querying on Workspaces, Documents, RDOs and system types. |
| 5/31/2017 | 9.5.162.111 | Enhancement | Services API | The View Manager service provides methods for creating, reading, and updating views. It includes the GetViewOwnersAsync() method for retrieving workspaces users who can be assigned ownership of a view, as well as the GetAccessStatusAsync() method for retrieving information about whether a user has View permissions on a view and on the fields used in the search conditions on a view. The GetObjectTypesAsync() method retrieves a list of the object types in a workspace, which you can use to assign an object type to a view based on the objects that you want displayed in it. The new IViewManager interface is available in the Relativity.Services.View namespace. For more information, see View Manager (.NET). |
| 5/31/2017 | 9.5.162.111 | Enhancement | REST API | The View Manager service supports creates, reads, and updates views. It retrieves workspaces users who can be assigned ownership of a view. It retrieves information about whether a user has View permissions on a view and on the fields used in the search conditions on a view. This service retrieves a list of the object types in a workspace, which you can use to assign an object type to a view based on the objects that you want displayed in it. For more information, see View Manager (REST). |
| 4/26/2017 | 9.5.133.118 | Enhancement | Services API | You can now use the Services API to create, read, update, delete and query admin-level RDOs. For more information, see RDO. |
| 4/26/2017 | 9.5.133.118 | Enhancement | Services API | The CopySingleAsync() method is now available in the IAnalyticsSearchManager, IdtSearchManager, and IKeywordSearchManager interfaces. The method allows you to create a copy of a specified saved search in the same folder. For more information, see Analytics Search Manager (.NET), Legacy dtSearch Manager (.NET), and Keyword Search Manager (.NET) |
| 4/26/2017 | 9.5.133.118 | Enhancement | Services API | You can now use the GetAccessStatusAsync() helper method to return the information about the user's ability to access a saved search or a document folder. The method is available on the IAnalyticsSearchManager, IdtSearchManager, IKeywordSearchManager, and IFolderManager interfaces. For more information, see Analytics Search Manager (.NET), Legacy dtSearch Manager (.NET), Keyword Search Manager (.NET), and Folder Manager (.NET). |
| 4/26/2017 | 9.5.133.118 | Enhancement | Services API | The MoveAsync() method in the IAnalyticsSearchManager, IdtSearchManager, IKeywordSearchManager, and ISearchContainerManager interfaces now allows you to move a saved search or a saved search folder to a different saved search folder. For more information, see Analytics Search Manager (.NET), Legacy dtSearch Manager (.NET), Keyword Search Manager (.NET), and Search Container Manager (.NET). |
| 4/26/2017 | 9.5.133.118 | Enhancement | REST API | The Analytics Search Manager, dtSearch Manager, and Keyword Search Manager REST services now include the CopySingleAsync endpoint. The endpoint allows you to create a copy of a specified saved search in the same folder. For more information, see Analytics Search Manager (.NET), Legacy dtSearch Manager (.NET), and Keyword Search Manager (.NET) |
| 4/26/2017 | 9.5.133.118 | Enhancement | REST API | The GetAccessStatusAsync endpoint in the Analytics Search Manager, dtSearch Manager, Keyword Search Manager, and Folder Manager REST services now allows you to return the information about the user's ability to access a saved search or a document folder. For more information, see Analytics Search Manager (.NET), Legacy dtSearch Manager (.NET), Keyword Search Manager (.NET), and Folder Manager (REST). |
| 4/26/2017 | 9.5.133.118 | Enhancement | REST API | You can use the new MoveAsync endpoint in the Analytics Search Manager, dtSearch Manager, Keyword Search Manager, and Search Container Manager REST services to move a saved search or a saved search folder to a different saved search folder. For more information, see Analytics Search Manager (REST), Legacy dtSearch Manager (REST), Keyword Search Manager (REST), and Search Container Manager (.NET). |
| 4/26/2017 | 9.5.133.118 | Enhancement | Relativity Integration Points API | The FieldEntry class has a new property called Type, which is a string that indicates the Relativity field type. This class is available in the kCura.IntegrationPoints.Contracts.Models namespace. |
| 2/22/2017 | 9.5.69.85 | Defect | REST API | Fixed an issue with the ARM API where move jobs could not be updated. |
| 2/22/2017 | 9.5.69.85 | Defect | REST API | Fixed validation of “Existing Target Database” field when creating restore jobs via the ARM API. |
| 2/22/2017 | 9.5.69.85 | Defect | REST API | Groups can now be auto-mapped when restoring via the ARM API. |
| 2/22/2017 | 9.5.69.85 | Enhancement | REST API | The ARM API now supports specifying the Analytics server to restore for ARM restore jobs when the archive contains Analytics data. |
| 2/22/2017 | 9.5.69.85 | Enhancement | Structured Analytics API | The new Structured Analytics API includes functionality for automating a full or incremental analysis of a structured analytics set, checking the status of the analysis, retrieving document and other errors, and performing additional tasks. It contains the IStructuredAnalyticsManager interface that exposes the overloaded RunFullAsync(), RunIncrementalAsync(), GetErrorsAsync(), and other methods. The Structured Analytics API also exposes endpoints through REST, which support similar functionality. For more information, see Structured Analytics (.NET). |
| 2/22/2017 | 9.5.69.85 | Enhancement | Services API | In the Services API, the Folder Manager service now includes the new MoveFolderAsync() method, which you can use to move a folder and its children, including subfolders and documents. It also includes the new FolderMoveResultSet class. The MoveFolderAsync() method returns an object of this type that provides information about the status of the move operation. For more information, see Folder Manager (.NET). |
| 2/22/2017 | 9.5.69.85 | Enhancement | REST API | In the REST API, the Folder Manager service now supports the MoveFolderAsync() endpoint, which you can use to move a folder and its children, including subfolders and documents. For more information, see Folder Manager (REST). |
| 1/25/2017 | 9.5.41.87 | Breaking change | Relativity Database | Relativity has deprecated support for the EDDSResource database. Mass Operation handlers that reference tables in this database won’t function properly. Instead, update these handlers to reference the new location under the workspace database with the [Resource] schema qualifier. |
| 1/25/2017 | 9.5.41.87 | Enhancement | Services API | In the Services API, the Object Query Manager service now includes the new overloaded QueryUniqueFieldValuesAsync() method used to query for unique values in fixed-length text fields. It also includes the new ObjectQueryUniqueFieldValuesResult class. The QueryUniqueFieldValuesAsync() method returns an object of this type, which contains the list of unique field values. For more information, see Query for Relativity objects. |
| 1/25/2017 | 9.5.41.87 | Enhancement | REST API | The new ARM API provides a REST service that supports multiple operations required to archive, restore, and move Relativity workspace data. For more information, see . |
| 1/25/2017 | 9.5.41.87 | Enhancement | REST API | In the REST API, the Object Query Manager service now supports the new QueryUniqueFieldValuesAsync endpoint used to query for unique values in fixed-length text fields. For more information, see Object queries. |
| 11/30/2016 | 9.4.378.21 | Enhancement | Services API | Use the SendBulkInvitationAsync method of the ILoginProfileManager interface to send invitation emails to multiple users. Before sending the emails, you can test whether the users are properly configured with the VerifyBulkInvitationAsync method. For more information, see Send login invitation email . |
| 11/30/2016 | 9.4.378.21 | Enhancement | REST API | The Login Profile Manager service now provides the SendBulkInvitationAsync and VerifyBulkInvitationAsync endpoints for sending out invitation to multiple users. For more information, see Send invitation email with REST |
| 11/30/2016 | 9.4.378.21 | Enhancement | Services API | The Services API now includes the Logging Configuration Manager, the Logging Rule Manager, and the Logging Sink Manager services. These services support programmatically interacting with the Relativity logging framework. The interfaces used to access these services are available in the Relativity.Services.LoggingConfig namespace. This namespace also includes the Configuration, Rule, and Sink classes used in conjunction with the new services. |
| 11/30/2016 | 9.4.378.21 | Enhancement | REST API | The REST API now includes logging configuration services for creating and retrieving configurations, rules, and sinks used in the Relativity logging framework. It also provides endpoints for deleting configurations and rules. This new coverage includes the Logging Configuration Manager, the Logging Rule Manager, and the Logging Sink Manager services. |
| 11/30/2016 | 9.4.378.21 | Enhancement | Relativity Scripts | We have added the timezone input constant for specifying time zone offset in Relativity scripts. For more information, see constant. |
| 11/15/2016 | 9.4.361.1 | Enhancement | Services API | Added the overloaded CreateAsync method to the IOAuth2ClientManager interface to accept an OAuth2Client object for creating an OAuth2 client with a specified, rather than an autogenerated, ID. For more information, see Create an OAuth2 client. |
| 11/15/2016 | 9.4.361.1 | Enhancement | REST API | You can now use the OAuth2 Client Manager REST service to create OAuth2 clients with a specified ID. For more information, see Create an OAuth2 client with REST. |
| 11/15/2016 | 9.4.361.1 | Enhancement | Data Grid | You can now use the LUCENESEARCH operator for data grid-enabled fields in the following search conditions. |
| 11/15/2016 | 9.4.361.1 | Enhancement | Services API | The Password Bank Manager service retrieves document passwords from the password bank used by processing and imaging. It includes the GetAllPasswordsAsync() method to retrieve passwords. For more information, see Password Bank Manager (.NET). |
| 11/15/2016 | 9.4.361.1 | Enhancement | REST API | The Password Bank Manager service retrieves document passwords from the password bank used by processing and imaging. It includes the GetAllPasswordsAsync endpoint to retrieve passwords. For more information, see Password Bank Manager (REST). |
| 10/4/2016 | 9.4.321.2 | Breaking change | Relativity Database | Relativity is phasing out support for the EDDSResource database as January 2017. Mass Operation handlers that reference tables in this database won’t function properly. Instead, update these handlers to reference the new location under the workspace database with the [Resource] schema qualifier. |
| 10/4/2016 | 9.4.321.2 | Enhancement | Invariant API | Relativity 9.4.321.2 includes general enhancements to Invariant. Due to these enhancements, you must update the reference to the Invariant.core.dll in custom Invariant plugins used in Relativity 9.4.321.2. |
| 10/4/2016 | 9.4.321.2 | Enhancement | REST API | The REST API now support the LUCENESEARCH operator for searching text in the Data Grid using the Object Query Manager service. For more information, see Work with Data Grid. |
| 10/4/2016 | 9.4.321.2 | Enhancement | Services API |
You can now use Lucene syntax when searching Data Grid-enabled fields through Relativity Object Queries. For more information, see Work with Data Grid. |
| 8/31/2016 | 9.4.284.1 | Enhancement | Services API |
Support for programmatic access to OAuth2 clients to authenticate against Relativity in a secure manner. The API allows you to create, read, update, and delete OAuth2 clients, and regenerate secrets for certain types of clients. You can perform the operations using the IOAuth2ClientManager interface. For more information, see OAuth2 clients. |
| 8/31/2016 | 9.4.284.1 | Enhancement | Services API |
You can create, read, update, and delete federated instances using the IFederatedInstanceManager interface. For more information, see Federated instances. |
| 8/31/2016 | 9.4.284.1 | Enhancement | REST API |
Coverage for OAuth2 clients through REST. The API allows you to create, read, update, and delete OAuth2 clients, and regenerate secrets for certain types of clients. You can perform the operations using the OAuth2 Client Manager REST service. For more information, see OAuth2 clients. |
| 8/31/2016 | 9.4.284.1 | Enhancement | REST API |
You can create, read, update, and delete federated instances using the Federated Instance Manager REST service. For more information, see Federated instances. |
| 8/31/2016 | 9.4.284.1 | Breaking change | Relativity Scripts | We have removed the foreign keys from the Document and RDO database tables. This includes artifact, single object, and multi-object table relationships. Doing this resolves the previous issues involved with globally locking the artifact and other tables for the entire duration of a deletion job, which could be lengthy and could subsequently delay document review. As a result of removing these foreign keys, the delete process will execute without applying a global lock, allowing the system to then batch delete records without delaying document review in Relativity. |
| 7/27/2016 | 9.4.254.2 | Enhancement | Services API | The Services API now provides the SendInvitationAsync and SetPasswordAsync methods for working with the Relativity user login profile. Use the methods to send login invitation emails (after creating users) and reset Relativity passwords. For more information, see Login profile. |
| 7/27/2016 | 9.4.254.2 | Enhancement | REST API | You can now use the Login Profile Manager service SendInvitationAsync and SetPasswordAsync operations to send login invitation emails and resetting Relativity passwords. For more information, see Login Profile Manager REST service. |
| 7/27/2016 | 9.4.254.2 | Enhancement | Processing API | The ProcessingDataSource class now includes the new StartNumber property, which represents the value used to begin numbering a sequence of documents published from a specific data source. The new IsStartNumberVisible property determines whether the Relativity UI displays the Start Number field on the Data Source layout. The REST API also supports these properties. For more information, see Get started with the Processing API. |
| 7/27/2016 | 9.4.254.2 | Breaking change | Relativity Scripts | We have changed the [Redaction] data table to more accurately store information. Changing the datatype of the existing columns could take over an hour on certain large cases, and so instead, the following four nullable decimal columns have been added: Redaction.[X_d], Redaction. [Y_d], Redaction. [Width_d], Redaction. [Height_d]. |
| 7/27/2016 | 9.4.254.2 | Defect | Import API | Production imports through Import API in overlay mode now correctly update existing documents |
| 7/27/2016 | 9.4.254.2 | Defect | Import API | Dynamic objects created through the Import API are now correctly audited in the audit table. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Services API | Added support for common authentication protocols, including SAML 2.0, Open ID Connect (OIDC), and OAuth2. Using these protocols, you can now authenticate to Relativity via many popular identity providers, such as Okta or Azure Active Directory. For the authentication overview, see Authentication overview. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Services API | API coverage has been added around the new authentication model, allowing developers to programatically configure authentication providers and users in Relativity. For the authentication API overview, see Authentication API overview. |
| 6/29/2016 | 9.4.224.2 | Breaking change | Services API | When using the RSAPI, all authentication-related fields on the User object now have an Obsolete tag. If an application consuming these APIs has “Treat Warnings as Errors” turned on, this will cause a minor compile-time breaking change. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Services API | The new Field Mapping service maps fields between Relativity and an external data source. For this release, the only external data source supported by this service is Invariant. For more information, see Field mapping for processing. |
| 6/29/2016 | 9.4.224.2 | Defect | Services API | Relativity Service Catalog now uses one timer to reset data in the service catalog, instead of a new timer for each request. |
| 6/29/2016 | 9.4.224.2 | Enhancement | API Helpers | You can now use the GetGuid() method of the API helper interfaces to return the GUID of a Relativity artifact from agents, custom pages, and event handlers. For more information, see Basic concepts for Relativity API Helpers. |
| 6/29/2016 | 9.4.224.2 | Enhancement | REST API | The new Field Mapping service maps fields between Relativity and an external data source. For this release, the only external data source supported by this service is Invariant. For more information, see Field mapping. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Invariant API | The Invariant API now includes the GetAutoMappedGuids() method for internal use only. The IDataSources interface in the Invariant namespace contains this method. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Relativity Integration Points API | The kCura.IntegrationPoints.Contracts namespace now includes the new ProviderFactoryBase class, which simplifies the implementation of dependency injection. For more information, see Update the use of dependency injection. This namespace also includes the new SourceProviderConfiguration class, which includes optional properties that control source provider behavior, such as whether Relativity copies native files to a repository. For sample code, see Display source provider settings selected by users and Build an advanced integration point. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Relativity Integration Points API | The FieldEntry class has the new ActualName property, which is the name used for the field in the source code. This class is available in the kCura.IntegrationPoints.Contracts.Models namespace. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Relativity Integration Points API | The kCura.IntegrationPoints.Contracts.Provider namespace now includes the new ProviderReadDataException class, which represents an error thrown by an IDataReader when a read failure occurs. |
| 6/29/2016 | 9.4.224.2 | Enhancement | Relativity Integration Points API | The kCura.IntegrationPoints.SourceProviderInstaller namespace includes an update to the SourceProvider class, which has the new Configuration property. This property is used to get or set a list of optional properties that control source provider behavior. |
| 6/29/2016 | 9.4.224.2 | Deprecated | Relativity Integration Points API | The kCura.IntegrationPoints.Contracts.Synchronizer namespace has been deprecated. The DefaultProviderFactory class, IProviderFactory interface, and PluginBuilder class in the kCura.IntegrationPoints.Contracts namespace have also been deprecated. In addition, the FieldMap class and FieldMapTypeEnum enumeration in the kCura.IntegrationPoints.Contracts.Models namespace have been deprecated. For upgrade information, see Upgrade integration points for use in Relativity 9.4. |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | The Services API allows you to programmatically interact with production data sources. For more information, see Production Data Source Manager (REST). |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | The REST now allows you to programmatically interact with production data sources. For more information, see Production Data Source Manager (REST) in the REST API reference. |
| 5/25/2016 | 9.3.418.9 | Enhancement | REST API | You can now create productions using the CreateSingleAsync() method of the IProductionsManager interface. For more information, see Production Manager (.NET). |
| 5/25/2016 | 9.3.418.9 | Enhancement | REST API | You can now create productions using the CreateSingleAsync endpoint of the Production Manager Service. For more information, see Production Manager (REST). |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | Separate CreateSingleAsync() and UpdateSingleAsync() methods of the IProductionPlaceholder have been added for creating and updating production placeholders. The SaveSingleAsync() method of the IProductionPlaceholder interface has been deprecated. For more information, see Production Placeholder Manager (.NET). |
| 5/25/2016 | 9.3.418.9 | Deprecated | REST API | Separate CreateSingleAsync and UpdateSingleAsync endpoints have been added to the Production Placeholder Manager service for creating and updating production placeholders. The SaveSingleAsync endpoint has been deprecated. For more information, see Production Placeholder Manager (REST). |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | Use the GetAllAsync() method of the IProductionManager to return a list of all productions in a workspace. GetAllProductionsAsync() has been deprecated. For more information, see Production Manager (.NET). |
| 5/25/2016 | 9.3.418.9 | Deprecated | REST API | Use the GetAllAsync endpoint of the Production Manager service to return a list of all productions in a workspace. GetAllProductionsAsync has been deprecated. For more information, see Production Manager (REST). |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | The suppressWarnings parameter has been added to the RunProductionAsync() method of the IProductionManager interface to indicate whether a production should fail if there are warning messages. For more information, see Production Manager (.NET). |
| 5/25/2016 | 9.3.418.9 | Enhancement | REST API | The suppressWarnings parameter has been added to the RunProductionAsync endpoint of the Production Manager service to indicate whether a production should fail if there are warning messages. For more information, see Production Manager (REST). |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | The TextCondition class now supports the IS SET and IS NOT SET operators for querying text in the Data Grid. For more information, see Work with Data Grid. |
| 5/25/2016 | 9.3.418.9 | Enhancement | REST API | The REST API now support the IS SET and IS NOT SET operators for querying text in the Data Grid. For more information, see Work with Data Grid. |
| 5/25/2016 | 9.3.418.9 | Enhancement | Services API | You can now use the MonthOf operator in the Services API date queries. For more information, see Search Relativity. |
| 5/25/2016 | 9.3.418.9 | Enhancement | REST API | You can now use the MonthOf operator in the REST API date queries. For more information, see Query for resources |
| 4/27/2016 | 9.3.389.9 | Enhancement | Processing API | In the Processing API, the ProcessingCustodian class now includes a CustodianType and Name property. The CustodianType property identifies the custodian as an individual or an entity who owns data in a processing set. The Name property corresponds to the Full Name field on a Custodian object in Relativity. For more information, see Get started with the Processing API. |
| 4/27/2016 | 9.3.389.9 | Enhancement | Processing API | The Processing API now includes the GetDocumentAggregates() method on the IProcessingSetManager interface. This method retrieves a list of processing sets and related document aggregate information. It also includes the addition of the GetDocumentAggregatesRequest, ProcessingSetDocumentInfoSummary, and ProcessingSetDocumentInfo classes, which the GetDocumentAggregates() method uses during the retrieval of the required processing sets. For more information, see Get started with the Processing API. |
| 4/27/2016 | 9.3.389.9 | Enhancement | Processing API | The Processing API now includes the GetDocumentAggregates endpoint on Processing Set Manager service available through Relativity REST API. It provides the same functionality that is available through the GetDocumentAggregates() method on the IProcessingSetManager interface. For more information, see Processing API services for REST. |
| 4/27/2016 | 9.3.389.9 | Defect | Services API | Saved search queries in FluidUI have been updated to return the full range of the date-time values in search conditions instead of just the starting time. |
| 4/27/2016 | 9.3.389.9 | Defect | Services API | Relativity Services API has been updated to allow you to write to data grid-enabled fields. |
| 4/27/2016 | 9.3.389.9 | Enhancement | Services API | The ObjectQueryManager service now supports multi-reflected multiple choice fields in the response returned on a query. |
| 4/27/2016 | 9.3.389.9 | Enhancement | REST API | The ObjectQueryManager service now supports multi-reflected multiple choice fields in the response returned on a query. |
| 3/30/2016 | 9.3.362.9 | Defect | Services API | The ObjectQueryResultSet class name has been updated with the correct spelling. |
| 3/30/2016 | 9.3.362.9 | Enhancement | Services API | Relativity admins can now create RDOs in the Admin Mode area. For more information, see Relativity objects. |
| 3/2/2016 | 9.3.332.21 | Enhancement | Services API | The Services API now enables you to programmatically interact with the Relativity productions. For more information, see Production Manager (.NET) in the DTO reference. |
| 3/2/2016 | 9.3.332.21 | Enhancement | Services API | You can use the Services API to create, update, and delete production placeholders. For more information, see Production Placeholder Manager (.NET). |
| 3/2/2016 | 9.3.332.21 | Enhancement | REST API | The REST API now allows you to programmatically interact with the Relativity productions. For more information, see Production Manager (REST) in the REST API reference. |
| 3/2/2016 | 9.3.332.21 | Enhancement | REST API | You can use the REST API to create, read, update, and delete production placeholders. For more information, see Production Placeholder Manager (REST). |
| 3/2/2016 | 9.3.332.21 | Enhancement | Processing API | The Processing API includes the new SubmitInventoryJobsAsync() and SubmitPublishJobsAsync() methods used to perform inventory jobs and publish discovered data to a workspace respectively. See Get started with the Processing API. |
| 3/2/2016 | 9.3.332.21 | Enhancement | Services API | The DataResult object returned by the Object Query Manager service now contains the Includes property, which indicates the Field that was used to determine any related items added to your result set. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Processing API | The new Processing API includes the Processing Custodian Manager, Processing Data Source Manager, Processing Set Manager, and Processing Job Manager services used to automate processing workflows. See Get started with the Processing API. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The new Object Query Manager service queries for Document objects and Relativity Dynamic Objects (RDOs) in workspaces. |
| 11/23/2015 | 9.3.242.6 | Enhancement | REST API | The new Object Query Manager service queries for Document objects and Relativity Dynamic Objects (RDOs) in workspaces. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The new Search Provider Manager service retrieves a list of active search providers in a workspace, which can be displayed in the Relativity UI framework. |
| 11/23/2015 | 9.3.242.6 | Enhancement | REST API | The new Search Provider Manager service retrieves a list of active search providers in a workspace, which can be displayed in the Relativity UI framework. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The new Folder Manager service supports multiple operations for manipulating folder structures in the Relativity UI framework. |
| 11/23/2015 | 9.3.242.6 | Enhancement | REST API | The new Folder Manager service supports multiple operations for manipulating folder structures in the Relativity UI framework. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | Enhancements to the Pivot API include the new CreateProfileAsync() and UpdateProfileAsync() methods for creating or updating a pivot profile respectively. Additionally, the PivotIdToDisplayValueMap property on the PivotResultSet class is used to map column values to display values used in the Relativity UI when rendering data. |
| 11/23/2015 | 9.3.242.6 | Enhancement | REST API | Enhancements to the Pivot API include the new CreateProfileAsync() and UpdateProfileAsync() methods for creating or updating a pivot profile respectively. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The Search Container Manager has the new GetSearchContainerTreeAsync() method used to render an expanded browser tree for a saved search. |
| 11/23/2015 | 9.3.242.6 | Enhancement | REST API | The Search Container Manager service now supports retrieving information on expanded nodes in a specified search container. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The Query <T> class now has the SearchProviderCondition property, which is an object that holds the information necessary to run a query for the search provider used for pivoting on a base set of documents. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Event Handlers | The event handler framework provides enhanced support for File fields, including a FileValue class, Modified Updated property on the FieldValue class, new properties on the FileFieldValue class, and modified Value property behavior on the FileFieldValue class. You can now access a file stream associated with a File field, so that you can read the contents of the stream, or provide a new stream. For more information, see Support for File fields. |
| 11/23/2015 | 9.3.242.6 | Enhancement | REST API | The text query condition now supports the Greater than ('Foo' > 'Bar'), Less than ('Foo' < 'Bar'), and Contains ('Foobar' CONTAINS 'Bar') operators. For more information, see Query for resources. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The TextConditionEnum enumeration now supports the Greater than ('Foo' > 'Bar'), Less than ('Foo' < 'Bar'), and Contains ('Foobar' CONTAINS 'Bar') query conditions for text. For more information, see Search Relativity. |
| 11/23/2015 | 9.3.242.6 | Enhancement | Services API | The CopyInstancesOnParentCopy property of the ObjectType DTO now allows you to set up an ObjectType to automatically copy the instances of an object when its parent object is copied. For more information, see ObjectType and Update RDO properties and fields. |
| 11/23/2015 | 9.3.242.6 | Enhancement | API Helpers | Added the IAPILog interface to API Helpers to enable access to the Relativity logging infrastructure from agents, custom pages, and event handlers. For more information, see Basic concepts for Relativity API Helpers. |
| 11/23/2015 | 9.3.242.6 | Full support | Services API | Permissions coverage through the Services API is out of technology preview and is now fully supported. For more information, see Permission Manager (.NET). |
| 11/23/2015 | 9.3.242.6 | Full support | REST API | Permissions coverage through the REST API is out of technology preview and is now fully supported. For more information, see Permission Manager (.NET). |
| 11/23/2015 | 9.3.242.6 | Enhancement | Custom Pages | To enhance the security of Relativity user interface, we have removed the session variables from custom pages. Instead, use the methods available in the Relativity API helper interfaces to obtain the information such as user context and current workspace ID. For more information, see Basic concepts for Relativity API Helpers. |
| 9/30/2015 | 9.2.331.10 | Defect | Services API | Corrected a problem with the CreateSingle() method for documents. The operation now correctly returns ArtifactID when creating a document where the identifier contains Unicode. For more information, see Create documents. |
| 8/26/2015 | 9.2.296.16 | Enhancement | Services API | Added the GetItemLevelSecurityListAsync() method of the IPermissionManager interface to return a collection of item-level security settings for a specified list of artifacts. For more information, see Enabling item-level security. |
| 7/29/2015 | 9.2.271.9 | Enhancement | Services API | Added the GetPermissionSelectedListAsync() method of the IPermissionManager interface to return a collection of permission values for the current user and a specified list of artifacts. For more information, see Read the current user and group permission values. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added a beta implementation of APIs that enable you to manage permissions and security for users, system admins, and individual objects, and to define custom permissions for Relativity Dynamic Objects (RDOs). For more information, see Permission Manager (.NET). |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added asynchronous operations for creating, reading, updating, deleting, and querying Client objects. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added asynchronous operations for creating, reading, updating, deleting, and querying Matter objects. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added asynchronous operations for reading and updating Message of the Day (MotD) objects. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added support for using SavedSearchCondition and ViewCondition conditions in compound queries. For more information, see Search Relativity. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added asynchronous operations for creating, reading, updating, deleting, and querying saved search folders. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Services API | Added the Relativity.Services.Pivot namespace, which defines methods and classes for creating and running Pivot queries. |
| 5/30/2015 | 9.2.190.9 | Defect | Services API | Corrected a UTC translation problem in the DateTime query condition. The DateTime condition now evaluates only the date portion of a timestamp expression and ignores the time portion. |
| 5/30/2015 | 9.2.190.9 | Defect | Services API | Updated the Relativity installer to automatically install net.pipe and net.tcp bindings with WCF non-HTTP activation on agent servers. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added a beta implementation of APIs that enable you to manage permissions and security for users, system admins, and individual objects, and to define custom permissions for Relativity Dynamic Objects (RDOs). For more information, see Permission Manager (REST). |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added operations for creating, reading, updating, deleting, and querying Client objects. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added operations for creating, reading, updating, deleting, and querying Matter objects. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added operations for reading and updating Message of the Day (MotD) objects. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added support for using SavedSearchCondition and ViewCondition conditions in compound queries. For more information, see Query for resources. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added operations for creating, reading, updating, deleting, and querying saved search folders. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added the Pivot Manager Service, which defines operations and fields for working with custom Pivot queries and Pivot profiles. |
| 5/30/2015 | 9.2.190.9 | Enhancement | REST API | Added support for the RelAuth cookie to custom pages. Custom pages can now "piggy back” on browser-based authentication when making calls to the REST API. |
| 5/30/2015 | 9.2.190.9 | Defect | REST API | Corrected the issue that removed white space between words in REST responses. |
| 5/30/2015 | 9.2.190.9 | Enhancement | Import API | Updated the importJob.Settings.DataGridIDColumnName property to support mapping documents to records in Data Grid. |
| 1/30/2015 | 9.1.87.5 | Enhancement | Services API | Updated the object hierarchy in the Relativity framework to support multi-tenancy. The Client object is now the parent of Matter, Group, User, and Workspace objects. This means that there is a new workflow for setting the Client property on a Group DTO. In addition, the Parent Artifact property on User and Workspace DTOs is now set to a Client object. For more information, see Client, Group, User, and Workspace. |
| 1/28/2015 | 9.0.285.3 | Enhancement | Services API | Added full support for saved search APIs that were initially released in Relativity 9.0.198.5 as a Customer Technology Preview (CTP). |
| 1/28/2015 | 9.0.285.3 | Enhancement | Services API | Updated the architecture of Services API DLLs to deliver API functionality in multiple DLLs. |
| 1/28/2015 | 9.0.285.3 | Enhancement | Services API | Added support for accessing saved search APIs from agents, event handlers and custom pages. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Application Deployment System | Added support for packaging saved searches in Relativity applications and deploying them through the Application Deployment System (ADS). |
| 11/14/2014 | 9.0.198.5 | Enhancement | Application Deployment System | Added support for assigning custom, user-friendly URLs to Relativity applications. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Application Deployment System | Deprecated functionality for exporting applications as XML files. You can now export applications only as RAP files. In addition, applications developed in Relativity 9 or above can't be deployed to earlier versions, such as 8.2 or below, of Relativity. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Services API | Added CTP implementations of APIs for creating, reading, updating, and deleting saved searches. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Services API | Updated the ServiceFactory class to return proxies for any of the service interfaces in the Services API. You can use the class to create proxies for standalone .NET applications, specifying connection parameters in the associated ServiceFactorySettings class. API Helpers for event handlers, custom pages, and agents can also return any of the service interfaces in the Services API. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Services API | Updated the Value property of SingleChoiceCondition or MultiChoiceCondition objects to support an array of GUIDs that represent the Choices to compare against, in addition to continuing support for setting the property to a list or an array of Integer values. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Services API | Added the DefaultCacheLocation property to the Workspace DTO (kCura.Relativity.Client.DTOs namespace). You can use the property to get or set the ArtifactID of a server that’s designated as the default cache location for temporarily storing files for natives, images, and productions that are used by the viewer. |
| 11/14/2014 | 9.0.198.5 | Enhancement | Services API | Added the DefaultCacheLocation field to the WorkspaceFieldNames class (kCura.Relativity.Client.DTOs namespace). The field stores the Artifact ID of the server used to cache files. |
| 9/24/2014 | 9.0.198.5 | Enhancement | Import API | Updated various API components to improve performance significantly. You do not need to modify or update any existing code to leverage these enhancements. |
| 9/24/2014 | 8.2.340.4 | Enhancement | Import API | Significant performance enhancements, which you can leverage without making any modifications to your existing code. |
| 9/24/2014 | 8.2.340.4 | Enhancement | Services API | The RSAPI now uses HttpContext.Current.Items list instead of using data stored in the Session when making WebAPI and other calls. |
| 8/26/2014 | 8.2.320.2 | Defect | Services API | The GetRelativityScriptInputs() RSAPI method no longer returns incorrect results for Relativity script inputs. |
| 7/25/2014 | 8.2.287.4 | Defect | Application Deployment System | Default tabs can now be successfully imported through ADS. |
| 7/25/2014 | 8.2.287.4 | Defect | Services API | Blank GUID values no longer cause an error to be thrown when using the kCura.Client.DTO.FieldValue.AllFields directive to retrieve all fields. |
| 7/25/2014 | 8.2.287.4 | Defect | Services API | The admin choice enum has been updated and should be used in conjunction with the GetAdminChoiceTypes method to retrieve Artifact IDs for admin choices. |
| 7/25/2014 | 8.2.287.4 | Enhancement | Application Deployment System | Relativity applications can now optionally be assigned a short, user-friendly URL. |
| 5/30/2014 | 8.2.231.1 | Deprecated | Services API | CertificateFindValue property has been deprecated |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Using a ViewCondition and a Fields value of *SELECTEDFIELDS* in a query returns all expected Fields |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Using a ViewCondtion to retrieve multiple pages of results returns all values |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Executing a search with a condition using a GUID or Artifact ID |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Executing a Saved Search from an agent |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Querying with a sort containing an invalid Field fails consistently |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Setting choice values by GUID |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Querying for admin choices by Choice Type |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Updating a Client without the appropriate permissions fails with a valid exception |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Queries on fields recently added to an RDO or Document no longer fail |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Updating a Group without the proper permissions when no data is changing fails and throws a valid exception |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Querying a MultiObject Field with an ObjectConditionEnum.EqualTo condition fails with a valid error message |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Group names are validated consistently |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | User emails addresses are validated consistently |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Attempting to create an object with an invalid WorkspaceID returns a valid error message |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Reading a Document with StrictMode disabled no longer returns reflected Batch fields |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | ViewCondition queries are sorted by the View sort |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Deleting objects respects dependencies |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | ‘User’ field permissions are validated consistently on RDO creation |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | FieldType attribute on ‘Client’ field of User object is consistent |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | FieldType attribute on ‘Object Type’ field is consistent |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | FieldType attribute on ‘System Created By’ and ‘System Last Modified By’ fields is consistent |
| 5/30/2014 | 8.2.231.1 | Deprecated | Services API | Services API untyped create, read, update, delete, and query operations have been deprecated. |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | A system admin Platform Status tab has been added to monitor and display the status of the Relativity API endpoints. |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Index methods have been added to the Fields collection so that fields can be easily retrieved by ID, Name, or GUID. |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | A simplified pattern for performing an operation with a single artifact has been added. |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Using the Services API instead of SQL, users can create, update, and delete choices. |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | Using the Services API instead of SQL, users can create, update, and delete workspaces. |
| 5/30/2014 | 8.2.231.1 | Enhancement | Services API | A new property for getting back the user ID number for the currently logged in user has been added to the API helpers. |
| 9/22/2014 | 8.1.491.2 | Defect | Services API | The RSAPI now uses HttpContext.Current.Items list instead of using data stored in the Session when making WebAPI and other calls. |
| 8/26/2014 | 8.1.474.2 | Defect | Services API | The GetRelativityScriptInputs() RSAPI method no longer returns incorrect results for Relativity script inputs. |
| 7/25/2014 | 8.1.441.2 | Defect | Services API | Blank GUID values no longer cause an error to be thrown when using the kCura.Client.DTO.FieldValue.AllFields directive to retrieve all fields. |
| 7/25/2014 | 8.1.441.2 | Enhancement | Application Deployment System | Relativity applications can now optionally be assigned a short, user-friendly URL. |
| 1/29/2014 | 8.1.264.1 | Defect | Services API | A permission error will now be returned when a non-system admin user queries Relativity Scripts using the Services API. |
| 1/29/2014 | 8.1.264.1 | Defect | Services API | Deleted workspaces are no longer returned when querying through the Services API before the Case Manager agent runs. |
| 1/29/2014 | 8.1.264.1 | Enhancement | Application Deployment System | Relativity now supports applications up to 1 GB in size. |
| 12/23/2013 | 8.1.225.2 | Defect | Services API | Tokens are now removed on a regular interval, instead of every time a Dispose() method is called in the Services API. |
| 12/20/2013 | 8.1.223.7 | Defect | Services API | Logging in to the Services API via Integrated HTTPS will no longer fail when the client is on a different machine than the server. |
| 12/4/2013 | 8.1.202.3 | Defect | Import API | Import API folder creation now occurs server-side to avoid folder name collisions. |
| 11/26/2013 | 8.1.200.2 | Defect | Services API | Previously, a timeout occurred when using the Relativity Services API to update a multi-object field associated with documents in very large workspaces. A WHERE clause has now been added to the query in order to prevent a timeout. |
| 11/26/2013 | 8.1.200.2 | Defect | Application Deployment System | The "Enable Snapshot Auditing on Delete" property can now be edited, even if the object is part of a locked application. |
| 11/20/2013 | 8.1.195.1 | Defect | Services API | Self-hosted Services API instances in agents now correctly construct the URI, preventing a failed connection. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Application Deployment System | A new configuration value,AuditApplicationUninstallEnabled, controls whether or not delete audits are logged when uninstalling an application. Setting this value to No may improve application uninstall speeds in your case. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Application Deployment System | A new Workspace Create event handler type has been added for use when you want to run custom logic when creating a new workspace. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Application Deployment System | You can now easily and completely uninstall Relativity applications from a workspace. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Application Deployment System | You can attach uninstall event handlers to Relativity Applications to perform custom actions prior to the standard application uninstall process. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Application Deployment System | You can include pre- and post-install event handlers in an application to perform custom actions during the deployment of your application. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Application Deployment System | You can no longer lock applications that contain errors. |
| 11/8/2013 | 8.1.182.3 | Defect | Custom Pages | A user can now view a custom page from more than one Relativity session at the same time. |
| 11/8/2013 | 8.1.182.3 | Defect | Custom Pages | Previously, after upgrading Relativity, library DLLs were not automatically upgraded for custom pages. Now Procuro will automatically reset all applications if the Relativity version changes, and the custom page manager will refresh the library files. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Event Handlers | A new page interaction event handler has been created, which can be used to insert JavaScript and CSS easily on a page. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Import API | Performance has been improved for multiple threads using a single Import API. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Import API | Folder creation now occurs server-side to avoid folder name collisions. |
| 11/8/2013 | 8.1.182.3 | Enhancement | Import API | An option has been exposed to specify an overlay identifier on import. |
| 6/25/2014 | 8.0.291.1 | Defect | Services API | Searching by user ID against a user field with an ""is equal to"" condition via the Services API no longer causes a read failed error. |
| 6/25/2014 | 8.0.219.1 | Defect | Custom Pages | Custom page deployment no longer fails when the default IIS website is not named "Default Web Site." |
| 6/25/2014 | 8.0.247.1 | Defect | Application Deployment System | When a reflected single-choice field is removed from an application, but the associated field remains, the choices are no longer deleted. Additionally, the application layout will now properly update the list of single-choice fields without requiring a page refresh. |
| 6/25/2014 | 8.0.247.1 | Defect | Import API | Performance has been improved for multiple threads using a single Import API. |
| 6/25/2014 | 8.0.260.5 | Defect | Application Deployment System | When exporting an application, the Visible in Dropdown view setting will now be preserved. |
| 6/25/2014 | 8.0.291.1 | Defect | Services API | Document.Read() now only retrieves the fields and choices specified by the user. |
| 6/25/2014 | 8.0.302.1 | Defect | Services API | The login database table and cache are now kept in sync to prevent avoid authentication errors when logging back in to the Services API after a period of inactivity. |
| 6/25/2014 | 8.0.302.1 | Defect | Services API | GenerateRelativityAuthenticationToken now automatically authenticates Services API users. |
| 6/25/2014 | 8.0.302.1 | Defect | Import API | Native file and object importing has been optimized for the Import API by improving the creation of temporary tables. |
| 6/25/2014 | 8.0.316.2 | Defect | Services API | Using the RSAPIClient or ArtifactManagerProxy, the channel cache now allows you to connect to more than one Services API server from a single application. |
| 6/25/2014 | 8.0.233.1 | Defect | Event Handlers | When creating event handlers, checking if values are selected for a multi-object field on a layout now returns the correct result. |
| 6/25/2014 | 8.0.233.1 | Defect | Services API | The Services API programming samples now point to the correct folders to access third-party DLL files after the Relativity SDK is installed. |
| 6/25/2014 | 8.0.233.1 | Defect | Services API | The Services API no longer requires HTTPS to be configured on the Services API server when using NetNamedPipes or NetTCP to transmit metadata. |
| 6/25/2014 | 8.0.291.1 | Defect | Application Deployment System | Fields and objects can now be renamed when upgrading locked applications that conflict with themselves. |
| 1/29/2014 | 8.0.428.2 | Defect | Services API | A permission error will now be returned when a non-system admin user queries Relativity Scripts using the Services API. |
| 1/29/2014 | 8.0.428.2 | Defect | Services API | Deleted workspaces are no longer returned when querying through the Services API before the Case Manager agent runs. |
| 12/19/2013 | 8.0.387.6 | Defect | Services API | Logging into the Services API via Integrated HTTPS will no longer fail when the client is on a different machine than the server. |
| 12/4/2013 | 8.0.373.1 | Defect | Import API | Import API folder creation now occurs server-side to avoid folder name collisions. |
| 12/4/2013 | 8.0.373.1 | Defect | Services API | Tokens are now removed on a regular interval, instead of every time a Dispose() method is called. |
| 11/26/2013 | 8.0.358.1 | Defect | Services API | Previously, a timeout occurred when using the Relativity Services API to update a multi-object field associated with documents in very large workspaces. A WHERE clause has now been added to the query in order to prevent a timeout. |
| 11/26/2013 | 8.0.358.1 | Defect | Application Deployment System | The "Enable Snapshot Auditing on Delete" property can now be edited, even if the object is part of a locked application. |
| 10/9/2013 | 8.0.316.2 | Defect | Services API | Using the RSAPIClient or ArtifactManagerProxy, the channel cache now allows you to connect to more than one Services API server from a single application. |
| 9/25/2013 | 8.0.302.1 | Defect | Services API | GenerateRelativityAuthenticationToken now automatically authenticates Services API users. |
| 9/25/2013 | 8.0.302.1 | Defect | Services API | The login database table and cache are now kept in sync to prevent avoid authentication errors when logging back in to the Services API after a period of inactivity. |
| 9/25/2013 | 8.0.302.1 | Enhancement | Import API | Native file and object importing has been optimized for the Import API by improving the creation of temporary tables. |
| 9/13/2013 | 8.0.291.1 | Defect | Application Deployment System | Fields and objects can now be renamed when upgrading locked applications that conflict with themselves. |
| 9/13/2013 | 8.0.291.1 | Enhancement | Services API | The Services API has been updated to simplify configuration, increase performance, and provide an easier environment for developers. No code changes are required to take advantage of the new API, but any external applications that package their own client DLL must be recompiled with the new Services API client. |
| 9/13/2013 | 8.0.291.1 | Defect | Services API | Document.Read() now only retrieves the fields and choices specified by the user. |
| 9/13/2013 | 8.0.291.1 | Defect | Services API | Searching by user ID against a user field with an "is equal to" condition via the Services API no longer causes a read failed error. |
| 8/14/2013 | 8.0.260.5 | Defect | Application Deployment System | When exporting an application, the Visible in Dropdown view setting will now be preserved. |
| 7/31/2013 | 8.0.247.1 | Defect | Application Deployment System | When a reflected single-choice field is removed from an application, but the associated field remains, the choices are no longer deleted. Additionally, the application layout will now properly update the list of single-choice fields without requiring a page refresh. |
| 7/31/2013 | 8.0.247.1 | Defect | Import API | Performance has been improved for multiple threads using a single Import API. |
| 7/31/2013 | 8.0.247.1 | Defect | Import API | Folder creation now occurs server-side to avoid folder name collisions. |
| 7/31/2013 | 8.0.247.1 | Defect | Import API | An option has been exposed to specify an overlay identifier on import. |
| 7/17/2013 | 8.0.233.1 | Defect | Services API | The Services API no longer requires HTTPS to be configured on the Services API server when using NetNamedPipes or NetTCP to transmit metadata. |
| 7/17/2013 | 8.0.233.1 | Defect | Services API | The Services API programming samples now point to the correct folders to access third-party DLL files after the Relativity SDK is installed. |
| 7/17/2013 | 8.0.233.1 | Defect | Event Handlers | When creating event handlers, checking if values are selected for a multi-object field on a layout now returns the correct result. |
| 7/3/2013 | 8.0.219.1 | Defect | Custom Pages | Custom page deployment no longer fails when the default IIS website is not named "Default Web Site." |
| 7/3/2013 | 8.0.219.1 | Defect | Services API | Searching by user ID against a user field with an "is equal to" condition via the Services API no longer causes a read failed error. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Application Deployment System | Assemblies have been renamed to resource files. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Application Deployment System | You can safely load different versions of third party vendor assemblies in your environment. Each assembly (resource file) you upload must be attached to a Relativity Application. A new application domain will be created for each application type in your environment, and all associated resource files will be isolated from each other. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Application Deployment System | You can add an application to the master application library directly from your workspace using the new Push to Library button on the Relativity Application console. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Event Handlers | You can include pre and post install event handlers in an application to perform custom actions during the deployment of your application. |
| 5/10/2013 | 8.0.165.3 | Defect | Application Deployment System | Fixed an issue where users not in the System Administrator group could not export applications, even if they had the appropriate permissions. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | Relativity 8 provides a community preview of a new REST API that offers a subset of the functionality of the Services API (RSAPI), but allows for simple, cross-platform development. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The ArtifactManagerProxy class now includes a new method for logging in to Relativity that provides functionality for using Relativity credentials with Net.Pipe. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The Username/Password authentication scheme is now supported with the Net Named Pipes protocol. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The ArtifactManagerProxy class now includes a method for creating objects that populates the Results property with success and failure information, even in the case of a partial failure. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The ArtifactManagerProxy class now includes a method for deleting all artifacts of a specific type. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The ArtifactManagerProxy class now includes a method for deleting specified artifacts of a specifc type. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The ArtifactManagerProxy class now includes a new method for deleting all documents in a workspace. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | The human readable string for ObjectType's "Artifact Type ID" was changed to "Descriptor Artifact Type ID" to prevent some naming collisions. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | MassCreate and MassEdit now generate a SqlException of "Some supplied choice ids are invalid" if invalid choice ids are provided. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | Metadata is now always retrieved over the same endpoint over which client communication takes place. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | A new Relativity API provides a standard interface for establishing connections to databases and the Services API. This API also includes helper methods and unit testing tools that you can program against when developing agents, custom pages, and event handlers. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | Relativity 8 provides a newer REST API that offers parity in functionality with the Relativity Services API (RSAPI) but allows simple, fast, cross-platform development. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Services API | Relativity 8 has a new database configuration value called DeveloperMode. When enabled, this changes the behavior of Relativity in a development environment. |
| 5/10/2013 | 8.0.165.3 | Enhancement | Application Deployment System | You can include pre and post install event handlers in an application to perform custom actions during the deployment of your application. |
| 8/26/2014 | 7.5.634.47 | Defect | Services API | The GetRelativityScriptInputs() RSAPI method no longer returns incorrect results for Relativity script inputs. |
| 7/25/2014 | 7.5.634.30 | Defect | Services API | Blank GUID values no longer cause an error to be thrown when using the kCura.Client.DTO.FieldValue.AllFields directive to retrieve all fields. |
| 6/25/2014 | 7.5.632.40 | Defect | Services API | Searching by user ID against a user field with an ""is equal to"" condition via the Services API no longer causes a read failed error. |
| 6/25/2014 | 7.5.632.40 | Defect | Custom Pages | Custom page deployment no longer fails when the default IIS website is not named "Default Web Site." |
| 6/25/2014 | 7.5.632.58 | Defect | Application Deployment System | When a reflected single-choice field is removed from an application, but the associated field remains, the choices are no longer deleted. Additionally, the application layout will now properly update the list of single-choice fields without requiring a page refresh. |
| 6/25/2014 | 7.5.632.58 | Defect | Import API | Performance has been improved for multiple threads using a single Import API. |
| 6/25/2014 | 7.5.632.58 | Defect | Application Deployment System | When exporting an application, the Visible in Dropdown view setting will now be preserved. |
| 6/25/2014 | 7.5.632.68 | Defect | Services API | Document.Read() now only retrieves the fields and choices specified by the user. |
| 6/25/2014 | 7.5.632.83 | Defect | Services API | The login database table and cache are now kept in sync to prevent avoid authentication errors when logging back in to the Services API after a period of inactivity. |
| 6/25/2014 | 7.5.632.92 | Defect | Services API | GenerateRelativityAuthenticationToken now automatically authenticates Services API users. |
| 6/25/2014 | 7.5.632.92 | Defect | Import API | Native file and object importing has been optimized for the Import API by improving the creation of temporary tables. |
| 6/25/2014 | 7.5.633.12 | Defect | Services API | Using the RSAPIClient or ArtifactManagerProxy, the channel cache now allows you to connect to more than one Services API server from a single application. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | A new Object Rule Type, ""Mass Action Visiblity"", is available to hide the Edit, Replace, or Copy options from the Mass Actions list for any dynamic Object. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | A new Object Rule Type, ""Custom Single Object Add Link Visibility"", is available to control when the hyperlinked Add option is available on Layouts for Single Object fields. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | Relativity no longer unlinks multiple object instances from custom objects after an application upgrade. Instead, user-set multiple object instances will remain linked to custom objects after upgrading an application, regardless of how instances are linked in the application package. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | Session IDs and authentication tokens are now hashed with the SHA1 hashing algorithm before being stored in the Relativity database. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | Users can now set up contextual help on custom object layout categories. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | The Application Install Manager agent has been renamed to the Custom Page Installation Manager. The ApplicationInstallManagerIsOffHourAgent configuration value has also been renamed to CustomPageInstallationManagerIsOffHourAgent. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | You can now connect to SQL via a database connection property on kCura.Agent.AgentBase. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | Company Name, Copyright, and Description information can now be included on all assemblies, agent types, and event handlers. Company Name and Copyright are attributes that can be added to the assembly itself, while Description information can be added individually to each event handler or agent type in an assembly. |
| 6/25/2014 | 7.5.630.13 | Defect | Application Deployment System | The Mass Action Visibility object rule now includes an option to hide the "copy" mass action. |
| 6/25/2014 | 7.5.630.13 | Defect | Import API | The Import API now supports mapping to single-object and multi-object field values by Artifact ID. |
| 6/25/2014 | 7.5.630.28 | Defect | Services API | The Services API has been updated to allow authentication over HTTP when the CertificateFindValue is set in the app.config file. |
| 6/25/2014 | 7.5.630.50 | Defect | Services API | The correct data is now returned when querying the Services API for a multi-object field that references objects of the same type, or for documents with relational fields. |
| 6/25/2014 | 7.5.630.50 | Defect | Services API | The Services API query now filters saved searches correctly using the search text. |
| 6/25/2014 | 7.5.630.50 | Defect | Services API | Compiling the Relativity SDK sample solution no longer returns NUnit and assembly errors. |
| 6/25/2014 | 7.5.630.82 | Defect | Application Deployment System | An error is no longer displayed when importing an application with reflected choice fields. |
| 6/25/2014 | 7.5.630.82 | Defect | Services API | The Relativity Services API no longer displays an error following a first-time installation of 7.5 because of an invalid entry in the web configuration file. |
| 6/25/2014 | 7.5.630.82 | Defect | Services API | When using the RSAPI to query for artifacts, the artifact ID and GUID are now populated for each field in the query artifact fields collection. |
| 6/25/2014 | 7.5.630.94 | Defect | Services API | The Services API can now retrieve a Relativity authentication token for use during login. |
| 6/25/2014 | 7.5.630.94 | Defect | Services API | The Mass Edit command in the Services API no longer returns an error when trying to mass edit Yes/No fields. |
| 6/25/2014 | 7.5.631.14 | Defect | Application Deployment System | An intermittent HTTP error message no longer occurs when installing a new Relativity Application. |
| 6/25/2014 | 7.5.631.33 | Defect | Services API | Running a query through the Services API now returns field names with the appropriate spacing. |
| 6/25/2014 | 7.5.631.33 | Defect | Services API | When StrictMode is set to True, the field names used in fields selection, sorts, and conditions are no longer case-sensitive. |
| 6/25/2014 | 7.5.631.48 | Defect | Services API | TotalCount is now returned properly when querying objects that do not support paging through the Services API. |
| 6/25/2014 | 7.5.631.48 | Defect | Services API | An error is no longer returned when executing a saved search via the Services API while using a custom agent. |
| 6/25/2014 | 7.5.631.63 | Defect | Services API | The Services API no longer allows users to create a batch set based on saved searches they don't have permission to access. |
| 6/25/2014 | 7.5.631.63 | Defect | Services API | The Services API can now successfully query documents using the ArtifactGUID of a relational field. |
| 6/25/2014 | 7.5.631.63 | Defect | Services API | The Services API now allows creation of a document or RDO using its ArtifactTypeGUID. |
| 6/25/2014 | 7.5.631.63 | Defect | Services API | The Services API now correctly creates a document in the folder specified by the ParentArtifactID. |
| 6/25/2014 | 7.5.631.63 | Defect | Services API | The Services API now validates the FolderID to prevent creation of documents with an invalid FolderID. |
| 6/25/2014 | 7.5.631.63 | Defect | Import API | The RDC and Application Deployment System using the Import API can now run multiple imports concurrently without an error occurring when the imports create single- or multiple-object fields. |
| 6/25/2014 | 7.5.631.83 | Defect | Services API | An error is no longer returned when creating an RDO using the ExecuteBatch command. |
| 6/25/2014 | 7.5.631.83 | Defect | Services API | "The Services API now displays a more intuitive error message for the following actions: • Querying Artifact Type names longer than 50 characters. • Querying object types with a workspace ID equal to -1. • Creating or deleting objects with invalid authentication tokens. |
| 6/25/2014 | 7.5.632.20 | Defect | Import API | When multiple threads are imported using a single Import API, the temporary folder is no longer shared between all of the threads. |
| 6/25/2014 | 7.5.632.3 | Defect | Services API | The artifact type for the ParentArtifactID is now validated when creating a child RDO. |
| 6/25/2014 | 7.5.632.3 | Defect | Services API | When creating a child RDO, the Services API now automatically generates the Parent Object required field using the ParentArtifactID property. |
| 6/25/2014 | 7.5.632.3 | Defect | Import API | The Import API can now be installed on 32-bit machines using the Relativity SDK installer. |
| 6/25/2014 | 7.5.632.40 | Defect | Services API | The Services API client no longer leaves connections open if it fails while closing a faulted channel. |
| 1/29/2014 | 7.5.633.46 | Defect | Services API | Deleted workspaces are no longer returned when querying through the Services API before the Case Manager agent runs. |
| 1/29/2014 | 7.5.633.46 | Defect | Services API | A permission error will now be returned when a non-system admin user queries Relativity Scripts using the Services API. |
| 12/18/2013 | 7.5.633.36 | Defect | Services API | Logging into the Services API via Integrated HTTPS will no longer fail when the client is on a different machine than the server. |
| 11/20/2013 | 7.5.633.28 | Defect | Services API | Previously, a timeout occurred when using the Relativity Services API to update a multi-object field associated with documents in very large workspaces. A WHERE clause has now been added to the query in order to prevent a timeout. |
| 10/9/2013 | 7.5.633.12 | Defect | Services API | Using the RSAPIClient or ArtifactManagerProxy, the channel cache now allows you to connect to more than one Services API server from a single application. |
| 9/25/2013 | 7.5.632.92 | Enhancement | Import API | Native file and object importing has been optimized for the Import API by improving the creation of temporary tables. |
| 9/25/2013 | 7.5.632.92 | Defect | Services API | GenerateRelativityAuthenticationToken now automatically authenticates Services API users. |
| 9/25/2013 | 7.5.632.92 | Defect | Services API | The login database table and cache are now kept in sync to prevent avoid authentication errors when logging back in to the Services API after a period of inactivity. |
| 9/13/2013 | 7.5.632.83 | Enhancement | Services API | The Services API has been updated to simplify configuration, increase performance, and provide an easier environment for developers. No code changes are required to take advantage of the new API, but any external applications that package their own client DLL must be recompiled with the new Services API client. |
| 9/13/2013 | 7.5.632.83 | Defect | Services API | Document.Read() now only retrieves the fields and choices specified by the user. |
| 8/14/2013 | 7.5.632.68 | Defect | Application Deployment System | When exporting an application, the Visible in Dropdown view setting will now be preserved. |
| 7/31/2013 | 7.5.632.58 | Defect | Import API | Performance has been improved for multiple threads using a single Import API. |
| 7/31/2013 | 7.5.632.58 | Defect | Import API | Folder creation now occurs server-side to avoid folder name collisions. |
| 7/31/2013 | 7.5.632.58 | Defect | Import API | An option has been exposed to specify an overlay identifier on import. |
| 7/31/2013 | 7.5.632.58 | Defect | Application Deployment System | When a reflected single-choice field is removed from an application, but the associated field remains, the choices are no longer deleted. Additionally, the application layout will now properly update the list of single-choice fields without requiring a page refresh. |
| 7/3/2013 | 7.5.632.40 | Defect | Custom Pages | Custom page deployment no longer fails when the default IIS website is not named "Default Web Site." |
| 7/3/2013 | 7.5.632.40 | Defect | Services API | Searching by user ID against a user field with an "is equal to" condition via the Services API no longer causes a read failed error. |
| 7/3/2013 | 7.5.632.40 | Defect | Services API | The Services API client no longer leaves connections open if it fails while closing a faulted channel. |
| 5/22/2013 | 7.5.632.3 | Defect | Import API | The Import API can now be installed on 32-bit machines using the Relativity SDK installer. |
| 5/22/2013 | 7.5.632.3 | Defect | Services API | When creating a child RDO, the Services API now automatically generates the Parent Object required field using the ParentArtifactID property. |
| 5/22/2013 | 7.5.632.3 | Defect | Services API | The artifact type for the ParentArtifactID is now validated when creating a child RDO. |
| 6/5/2013 | 7.5.632.20 | Defect | Import API | When multiple threads are imported using a single Import API, the temporary folder is no longer shared between all of the threads. |
| 5/8/2013 | 7.5.631.83 | Defect | Services API | The Services API now displays a more intuitive error message for the following actions:•Querying Artifact Type names longer than 50 characters.•Querying object types with a workspace ID equal to -1.•Creating or deleting objects with invalid authentication tokens. |
| 5/8/2013 | 7.5.631.83 | Defect | Services API | An error is no longer returned when creating an RDO using the ExecuteBatch command. |
| 4/24/2013 | 7.5.631.63 | Defect | Import API | The RDC and applications using the Import API can now run multiple imports concurrently without an error occurring when the imports create single- or multiple-object fields. |
| 4/24/2013 | 7.5.631.63 | Defect | Services API | The Services API now validates the FolderID to prevent creation of documents with an invalid FolderID. |
| 4/24/2013 | 7.5.631.63 | Defect | Services API | The Services API now correctly creates a document in the folder specified by the ParentArtifactID. |
| 4/24/2013 | 7.5.631.63 | Defect | Services API | The Services API now allows creation of a document or RDO using its ArtifactTypeGUID. |
| 4/24/2013 | 7.5.631.63 | Defect | Services API | The Services API can now successfully query documents using the ArtifactGUID of a relational field. |
| 4/24/2013 | 7.5.631.63 | Defect | Services API | The Services API no longer allows users to create a batch set based on saved searches they don't have permission to access. |
| 4/10/2013 | 7.5.631.48 | Defect | Services API | An error is no longer returned when executing a saved search via the Services API while using a custom agent. |
| 4/10/2013 | 7.5.631.48 | Defect | Services API | TotalCount is now returned properly when querying objects that do not support paging through the Services API. |
| 3/27/2013 | 7.5.631.33 | Defect | Services API | When StrictMode is set to True, the field names used in fields selection, sorts, and conditions are no longer case-sensitive. |
| 3/27/2013 | 7.5.631.33 | Defect | Services API | Running a query through the Services API now returns field names with the appropriate spacing. |
| 3/13/2013 | 7.5.631.14 | Defect | Application Deployment System | An intermittent HTTP error message no longer occurs when installing a new Relativity Application. |
| 2/27/2013 | 7.5.630.94 | Defect | Services API | The Mass Edit command in the Services API no longer returns an error when trying to mass edit Yes/No fields. |
| 2/27/2013 | 7.5.630.94 | Defect | Services API | The Services API can now retrieve a Relativity authentication token for use during login. |
| 2/13/2013 | 7.5.630.82 | Defect | Services API | When using the RSAPI to query for artifacts, the artifact ID and GUID are now populated for each field in the query artifact fields collection. |
| 2/13/2013 | 7.5.630.82 | Defect | Services API | The Relativity Services API no longer displays an error following a first-time installation of 7.5 because of an invalid entry in the web configuration file. |
| 2/13/2013 | 7.5.630.82 | Defect | Application Deployment System | An error is no longer displayed when importing an application with reflected choice fields. |
| 1/16/2013 | 7.5.630.50 | Defect | Services API | Compiling the Relativity SDK sample solution no longer returns NUnit and assembly errors. |
| 1/16/2013 | 7.5.630.50 | Defect | Services API | The Services API query now filters saved searches correctly using the search text. |
| 1/16/2013 | 7.5.630.50 | Defect | Services API | The correct data is now returned when querying the Services API for a multi-object field that references objects of the same type, or for documents with relational fields. |
| 12/19/2012 | 7.5.630.28 | Defect | Services API | The Services API has been updated to allow authentication over HTTP when the CertificateFindValue is set in the app.config file. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Import API | The Import API now supports mapping to single-object and multi-object field values by Artifact ID. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | The Mass Action Visibility object rule now includes an option to hide the "copy" mass action. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | Company Name, Copyright, and Description information can now be included on all assemblies, agent types, and event handlers. Company Name and Copyright are attributes that can be added to the assembly itself, while Description information can be added individually to each event handler or agent type in an assembly. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | You can now connect to SQL via a database connection property on kCura.Agent.AgentBase. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | The Application Install Manager agent has been renamed to the Custom Page Installation Manager. The ApplicationInstallManagerIsOffHourAgent configuration value has also been renamed to CustomPageInstallationManagerIsOffHourAgent. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | Users can now set up contextual help on custom object layout categories. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | Session IDs and authentication tokens are now hashed with the SHA1 hashing algorithm before being stored in the Relativity database. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | Relativity no longer unlinks multiple object instances from custom objects after an application upgrade. Instead, user-set multiple object instances will remain linked to custom objects after upgrading an application, regardless of how instances are linked in the application package. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | A new Object Rule Type, "Custom Single Object Add Link Visibility", is available to control when the hyperlinked Add option is available on Layouts for Single Object fields. |
| 11/30/2012 | 7.5.630.13 | Enhancement | Application Deployment System | A new Object Rule Type, "Mass Action Visiblity", is available to hide the Edit, Replace, or Copy options from the Mass Actions list for any dynamic Object. |
|
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 | ||
