Batch Sets Manager (REST)

A batch set is a group of batches, which contain documents for review as part of the e-discovery process. For more information, see Batches.

The Batch Sets Manager service exposes CRUD operations for batch sets. It also supports creating and purging batches for a batch set. As a sample use case, you could use the Batch Sets Manager service to implement an application that programmatically creates a batch set and the batches contained in it.

You can also use the Batch Sets Manager service through .NET. For more information, see Batch Sets Manager (.NET).

This page contains the following information:

Guidelines for the Batch Sets Manager service

Review the following guidelines for working with this service.

URLs

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set {versionNumber} to the version of the API, using the format lowercase v and the version number, such as v1.
  • Set other path parameters in the URLs to the Artifact ID of a given entity, such as {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

For example, you can use the following URL to retrieve a batch set:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets/{batchSetID}

Set the path parameters as follows:

  • {versionNumber} to the version of the API, such as v1.
  • {workspaceID} to the Artifact ID of the workspace that contains the batch set.
  • {batchSetID} to the Artifact ID of a specific batch set.

Client code sample

To use the Batch Sets Manager service, send requests by making calls with the required HTTP methods. You can use the following .NET code as a sample client for reading the properties of a batch set. For more information, see Read a batch set.

public async Task<BatchSet> ReadBatchSetViaREST(int workspaceID, int batchSetID)
{
    BatchSet result = null;
    string email = "username@email.com";
    string password = "password";
    using (HttpClient client = new HttpClient())
    {
        client.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
        client.DefaultRequestHeaders.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes($"{email}:{password}")));
        client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0");
 
        var url = $"http://localhost/Relativity.REST/api/relativity-review/v1/workspaces/{workspaceID}/batch-sets/{batchSetID}";
        var response = await client.GetAsync(url);
        response.EnsureSuccessStatusCode();
        var content = await response.Content.ReadAsStringAsync();
        result = JsonConvert.DeserializeObject<BatchSet>(content);
    }
 
    return result;
}

Create a batch set

To create a batch set, send a POST request to a URL with the following format:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets

Read a batch set

To read the properties of a batch set , send a GET request to a URL with the following format:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets/{batchSetID}

The body of the request is empty.

The response for a read operation contains the same fields as those for a create response. See the field descriptions for the response in Create a batch set.

Update a batch set

To update a batch set, send a PUT request to a URL with the following format:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets

The body of the request must contain a batchSet field, which represents a request for updating a batch set. It should contain the same fields as a create response. See the field descriptions for the response in Create a batch set.

When the batch set is successfully updated, the response returns the status code of 200.

Delete a batch set

To remove a batch set from Relativity, send a DELETE request to a URL with the following format:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets/{batchSetID}

The body of the request is empty.

When the batch set is successfully deleted, the response returns the status code of 200.

Create batches

To add batches to a batch set, send a POST request to a URL with the following format:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets/{batchSetID}/batches/create

The body of the request is empty.

The response returns an integer indicating the number of batches that were created.

500

Purge batches

To remove batches from a batch set, send a POST request to a URL with the following format:

<host>/Relativity.REST/api/relativity-review/{versionNumber}/workspaces/{workspaceID}/batch-sets/{batchSetID}/batches/purge

The body of the request is empty.

The response returns an integer indicating the number of batches that were purged.

500

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.