This DTO has been deprecated as part of the Relativity Services API (RSAPI) Deprecation and is no longer supported. For more information and alternative APIs, see RSAPI deprecation process.

Batch

A Batch resource represents a Relativity batch available in a workspace. A batch consists of a set of documents based on criteria determined by a system admin. You can use the REST API to read, update, and query Batch objects. For more information, see on Batches on the Relativity Documentation site.

You can also interact with Batch objects through the Relativity Services API. For more information, see Batch under RSAPI reference for .NET.

This page contains the following information:

GET method

You can use the GET method to retrieve a single Batch or a collection of all Batches in a workspace. You can find a general overview of this functionality in Create and update resources.

Retrieve a single Batch

When you retrieve a single Batch, you must supply a unique identifier (such as a GUID or ArtifactID) for the resource.

Sample URL

This URL includes the Artifact ID for the Workspace where the Batch resides, and for the Batch itself.

Copy 
<host>/Relativity.REST/Workspace/1016766/Batch/1037979

Response

Retrieve all Batches in a workspace

You can retrieve a collection of all Batches in a workspace with a GET method.

Sample URL

The URL indicates that you are retrieving a collection of Batch resources. You don't need to provide a body with this GET request.

Copy 
<host>/Relativity.REST/Workspace/1016766/Batch

Response

POST method

You can use the POST method to perform complex queries for Batches. For more information, see Query for resources.

Query for a Batch

You can set conditions used to query for a Batch resource.

Sample URL

Copy 
<host>/Relativity.REST/Workspace/1016766/Batch/QueryResult

Request

Response

PUT method

You can use the PUT method to update properties on a Batch. For more information, see Create and update resources.

Sample URL

This URL includes the Artifact ID for the Workspace where the Batch resides, and for the Batch itself.

Copy 
<host>/Relativity.REST/Workspace/1016766/Batch/1037982

Request

Response