Choice Manager (REST)

The Relativity REST API supports operations with the Choice objects though the Choice Manager service. The operations available through the service are equivalent to the asynchronous methods for interacting with the Choice objects.

For more information and method and class definitions, see Choice Manager (.NET) documentation.

This page contains the following information:

Guidelines for the Choice Manager service

Review the following guidelines for working with this service.

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.

Postman sample file

You can use the Postman sample file to become familiar with making calls to endpoints on the Choice Manager service. To download the sample file, click Choice Manager Postman file.

Client code sample

Create a single choice

Send a POST request to the Choice Manager service URL to create a choice:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices

Mandatory fields in the request are Field, Name, and Color.

Mass create choices

Send a POST request to the Choice Manager service URL to mass create choices:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices

Read a choice

You can retrieve basic or extended metadata for a choice. Extended metadata includes operations that you have permissions to perform on the choice, such as delete or update.

Send a GET request to the Choice Manager service URL to retrieve metadata:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/<ChoiceID>

The request body is empty.

Update a choice (no version check)

Send a PUT request to the Choice Manager service URL to update a choice:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/<ChoiceID>

The following is a sample URL for sending a PUT request to the Choice Manager service.

The response is a status code of 200 when the request is successful.

Update a choice (with version check)

Send a PUT request to the Choice Manager service URL to update a choice:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/<ChoiceID>

The following is a sample URL for sending a PUT request to the Choice Manager service.

The response is a status code of 200 when the request is successful.

Mass update choices

Send a PUT request to the Choice Manager service URL to mass update choices.

Note: All choices in a given mass update request must be associated with the same field.

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices

Delete a choice

Send a DELETE request to the Choice Manager service URL to delete a choice:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/<ChoiceID>   

The response is a status code of 200 when the request is successful.

Mass delete choices

Send a DELETE request to the Choice Manager service URL to mass delete choices:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices

The response is a status code of 200 when the request is successful.

Sort choices

Send a PUT request to the Choice Manager service URL to sort choices:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/sort

Move choices to start or end of list

Send a PUT request to the Choice Manager service URL to move choices:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/move

Move choices after a specific choice in a list

Send a PUT request to the Choice Manager service URL to move choices:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/move

Retrieve a list of available parents

Send a GET  request to the Choice Manager service URL to retrieve a list of available parents for a specific choice:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/<ChoiceID>/parents

Send a POST request to the Choice Manager service URL to retrieve a list of available parents for a specific field:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/parents

Retrieve a list of available colors

Send a GET request to the Choice Manager service URL to retrieve a list of available colors for a specific choice:

<host>/relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/<workspaceID>/choices/colors

No request body.

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.