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 Set

A Batch Set resource represents a Relativity batch set available in a workspace. A batch set contains multiple batches. You can use the REST API to create, read, update, delete, and query Batch Set objects. For more information, see on Batches on the Relativity Documentation site.

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

This page contains the following information:

GET method

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

Retrieve a single Batch Set

When you retrieve a single Batch Set, 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 Set resides, and for the Batch Set itself.

Copy 
<host>/Relativity.REST/Workspace/1017589/Batch%20Set/1039177

Response

Retrieve all Batch Sets in a workspace

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

Sample URL

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

Copy 
<host>/Relativity.REST/Workspace/1017589/Batch%20Set

Response

POST method

You can use the POST method to perform complex queries or to create Batch Set resources. For more information, see Query for resources and Create and update resources.

Query for a Batch Set

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

Sample URL

Copy 
<host>/Relativity.REST/Workspace/1017589/Batch%20Set/QueryResult

Request

Response

Create a Batch Set resource

You can create a Batch Set with a POST method. For more information, see Create and update resources.

Sample URL

Copy 
<host>/Relativity.REST/Workspace/1017589/Batch%20Set/

Request

Response

PUT method

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

Sample URL

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

Copy 
<host>/Relativity.REST/Workspace/1017589/Batch%20Set/1039176

Request

Response

DELETE method

You can use the DELETE method to remove a Batch Set from a Relativity workspace. You don't need to provide a body with a DELETE request.

Sample URL

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

Copy 
<host>/Relativity.REST/Workspace/1017589/Batch%20Set/1039178

Response