Choice Manager (REST)

In Relativity, choices are predetermined values of single and multi-choice list fields. You can perform operations on admin and workspace choices. For more general information, see Choices in the RelativityOne Documentation site.

The Choice Manager service exposes multiple operations you can use to programmatically manage choices in your Relativity environment. It includes the following features:

  • Supports create, read, update, and delete operations and mass operations on choices.
  • Provides helper endpoints used to sort choices, move choices in lists, and retrieve highlight colors and parent choices or fields.

As a sample use case, you could use the Choice Manager API to create choices used to perform specific operations in a custom application.

You can also use the Choice Manager API through .NET. For more information, see Choice Manager (.NET).

Guidelines for the Choice 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 the {versionNumber} placeholder to the version of the REST API that you want to use, using the format lowercase v and the version number, for example v1 or v2
  • Set other path parameters in the URLs to the Artifact ID of a given entity, for example setting {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 choice:

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

Set the path parameters as follows:

  • {versionNumber} to the version of the service, such as v1.
  • {workspaceID} to the Artifact ID of the workspace containing the choice.
  • {choiceID} to the Artifact ID of the choice.

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.

To get started with Postman, complete these steps:

  1. Obtain access to a Relativity environment. You need a username and password to make calls to your environment.
  2. Install Postman.
  3. Import the Postman sample file for the service. For more information, see Working with data files on the Postman web site.
  4. Select an endpoint. Update the URL with the domain for your Relativity environment and any other variables.
  5. In the Authorization tab, set the Type to Basic Auth, enter your Relativity credentials, and click Update Request.
  6. See the following sections on this page for more information on setting required fields for a request.
  7. Click Send to make a request.

Client code sample

You can use the following .NET code as a sample client for creating a choice.

Copy 
public async Task<int> CreateChoiceRestAsync()
{
 
    int choiceID = 0;
    using (Relativity.ObjectModel.V1.Choice.IChoiceManager choiceManager = _serviceFactory.CreateProxy<Relativity.ObjectModel.V1.Choice.IChoiceManager>())
    using (HttpClient client = new HttpClient())
    {
        client.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
        client.DefaultRequestHeaders.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("<user login>:<user password>")));
        client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0");
        client.BaseAddress = new Uri("http://localhost/");
 
        string inputJSON = @"{""choiceRequest"":{""Field"":{""ArtifactID"":1104632,""Guids"":[]},""Name"":""Relevant"",""Color"":3,""Order"":100}}";
        string url = "/Relativity.rest/api/relativity-object-model/{versionNumber}/workspaces/1022092/choices";
        HttpResponseMessage response = await client.PostAsync(url, new StringContent(inputJSON, Encoding.UTF8, "application/json"));
        response.EnsureSuccessStatusCode();
        string content = await response.Content.ReadAsStringAsync();
        choiceID = Int32.Parse(content);
    }
 
    return choiceID;
}

Create a single choice

To create a choice, send a POST request with a URL in the following format:

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

The request must contain a choiceRequest object with the following fields:

  • Field - identifiers for the field to associated with the new choice. It contains the following fields:
    • ArtifactID - an integer representing a unique identifier for a field.
    • Guids - an array of GUIDs used to identify a field.
  • Name - a string representing the user-friendly name of the choice.
  • Color - the highlight color for the choice.
  • Order - an integer used to determine order in which multiple choices are listed in UI. Lower values are listed first.
Copy 
{
    "choiceRequest": {
        "Field": {
            "ArtifactID": 1104632,
            "Guids": []
        },
        "Name": "Relevant",
        "Color": 3,
        "Order": 100
    }
}

The response contains the Artifact ID of the created choice.

Mass create choices

To create multiple choices in a mass operation, send a POST request with a URL in the following format:

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

The request must contain a massCreateChoiceRequest object with the following fields:

  • Choices - an array of choice names. This field sets the for the new choices and contains the names of the choices.
  • ChoiceTemplateData - contains information used to create the choices as follows:
    • Field - the identifiers for a field to be associated with the choices:
      • ArtifactID - an integer representing a unique identifier for the field.
      • Guids - an array of GUIDs used to identify the field.
Copy 
{
    "massCreateChoiceRequest": {
        "Choices": [
            {
                "Name": "Important",
                "Children": [
                    {
                        "Name": "Critical"
                    },
                    {
                        "Name": "Very"
                    },
                    {
                        "Name": "Somewhat"
                    }
                ]
            }
        ],
        "ChoiceTemplateData": {
            "Field": {
                "ArtifactID": 1104635,
                "Guids": []
            }
        }
    }
}

The response contains the following fields:

  • ChoicesCreated - an array of choices that were added. It contains the following fields for each choice:
    • ObjectIdentifier - containing the following fields:
      • Name - a string representing the user-friendly name of the choice.
      • ArtifactID - an integer representing a unique identifier for a choice.
      • Guids - an array of GUIDs used to identify a choice.
    • ParentChoice - containing the following fields:
      • ArtifactID - an integer representing a unique identifier for a parent choice.
      • Guids - an array of GUIDs used to identify a parent choice.
  • Success - a Boolean value indicating whether the move succeeded.
  • Message - explanatory information for an error when one occurs.
Copy 
{
    "ChoicesCreated": [
        {
            "ObjectIdentifier": {
                "Name": "Important",
                "ArtifactID": 1104660,
                "Guids": []
            },
            "ParentChoice": {
                "ArtifactID": 0,
                "Guids": []
            }
        },
        {
            "ObjectIdentifier": {
                "Name": "Critical",
                "ArtifactID": 1104661,
                "Guids": []
            },
            "ParentChoice": {
                "ArtifactID": 1104660,
                "Guids": []
            }
        },
        {
            "ObjectIdentifier": {
                "Name": "Very",
                "ArtifactID": 1104662,
                "Guids": []
            },
            "ParentChoice": {
                "ArtifactID": 1104660,
                "Guids": []
            }
        },
        {
            "ObjectIdentifier": {
                "Name": "Somewhat",
                "ArtifactID": 1104663,
                "Guids": []
            },
            "ParentChoice": {
                "ArtifactID": 1104660,
                "Guids": []
            }
        }
    ],
    "Success": true,
    "Message": ""
}

Read a choice

To retrieve the metadata for a choice, send a GET request with a URL in the following format (to list the choices for a field, see Object Rule Manager service):

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

The request body is empty.

The request contains the following fields:

  • ObjectIdentifier - containing the following fields:
    • Name - a string representing the user-friendly name of the choice.
    • ArtifactID - an integer representing a unique identifier for a choice.
    • Guids - an array of GUIDs used to identify a choice.
  • Field - identifiers for the field to associated with the choice. It contains the following fields:
    • Name - a string representing the user-friendly name of the field.
    • ArtifactID - an integer representing a unique identifier for a field.
    • Guids - an array of GUIDs used to identify a field.
  • Order - an integer used to determine order in which multiple choices are listed in UI. Lower values are listed first.
  • Color - contains the following field:
    • ID - an integer representing the highlight color for the choice.
  • Parent - identifiers for the parent associated with the choice. It contains the following fields:
    • ArtifactID - an integer representing a unique identifier for the parent.
    • Guids - an array of GUIDs used to identify the parent.
Copy 
{
    "ObjectIdentifier": {
        "Name": "Critical",
        "ArtifactID": 1104661,
        "Guids": []
    },
    "Field": {
        "Name": "Multi choice test field",
        "ArtifactID": 1104635,
        "Guids": []
    },
    "Order": 1000,
    "Color": {
        "ID": 3
    },
    "Parent": {
        "ArtifactID": 1104660,
        "Guids": []
    }
}

Update a choice without a version check

To update a choice without a version check, send a PUT request with a URL in the following format:

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

The request contains choiceRequest object with the following fields:

  • Name - a string representing the user-friendly name of the choice.
  • Color - the highlight color for the choice.
  • Parent - identifiers for the parent associated with the choice. It contains the following fields:
    • Name - a string representing the user-friendly name of the parent.
    • ArtifactID - an integer representing a unique identifier for the parent.
    • Guids - an array of GUIDs used to identify the parent.
  • Order - an integer used to determine order in which multiple choices are listed in UI. Lower values are listed first.
Copy 
{
    "choiceRequest": {
        "Name": "Critical - 2",
        "Color": 3,
        "Parent": {
            "Name": "Important",
            "ArtifactID": 1104636,
            "Guids": []
        },
        "Order": 1000
    }
}

When the choice is update successfully, the response contains a status code of 200.

Update a choice with a version check

To update a choice with a version check, send a PUT request with a URL in the following format::

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

The request contains a choiceRequest object with the following fields:

  • Name - a string representing the user-friendly name of the choice.
  • Color - the highlight color for the choice.
  • Parent - identifiers for the parent associated with the choice. It contains the following fields:
    • Name - a string representing the user-friendly name of the parent.
    • ArtifactID - an integer representing a unique identifier for the parent.
    • Guids - an array of GUIDs used to identify the parent.
  • Order - an integer used to determine order in which multiple choices are listed in UI. Lower values are listed first.
  • objectVersionToken - the version token of the choice being updated.
Copy 
{
    "choiceRequest": {
        "Name": "Critical - 3",
        "Color": 3,
        "Parent": {
            "Name": "Important",
            "ArtifactID": 1104636,
            "Guids": []
        },
        "Order": 400
    },
    "objectVersionToken": "637499580733130000"
}

When the choice is update successfully, the response contains a status code of 200.

Mass update choices

To update multiple choices in a mass operation, send a PUT request with a URL in the following format

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

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

The request contains a massUpdateChoices object with an array of the following fields:

  • ObjectIdentifier - containing the following fields:
    • ArtifactID - an integer representing a unique identifier for a choice.
  • Name - a string representing the user-friendly name of the choice.
  • Color - an integer representing the highlight color for the choice.
Copy 
{
    "massUpdateChoices": [
        {
            "ObjectIdentifier": {
                "ArtifactID": 1104662,
            },
            "Name": "Relevant",
            "Color": 3
        },
        {
            "ObjectIdentifier": {
                "ArtifactID": 1104663,
            },
            "Name": "Confidential",
            "Color": 3
        }
    ]
}

The response contains the following fields:

  • TotalChoices - an integer indicating the number of choices affected.
  • Success - a Boolean value indicating whether the operation succeeded.
  • Message - explanatory information for an error when one occurs.
Copy 
{
    "TotalChoices":2,
    "Success":true,
    "Message":""
}

Delete a choice

To remove a choice from Relativity, send a DELETE request with a URL in the following format::

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

When the choice is deleted successfully, the response contains a status code of 200.

Mass delete choices

To remove multiple choices in a mass operation, send a DELETE request with a URL in the following format:

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

The request contains the following fields:

  • massDeleteRequest - a request object with the following field:
    • ChoiceIDs - an array of Artifact IDs for the choices to delete.
Copy 
{
    "massDeleteRequest": {
        "ChoiceIDs": [
            {
                "ArtifactID": 1104661,
            },
            {
                "ArtifactID": 1104662,
            },
            {
                "ArtifactID": 1104663,
            }
        ]
    }
}

The request contains the following fields:

  • TotalChoices - an integer indicating the number of choices affected.
  • Success - a Boolean value indicating whether the operation succeeded.
  • Message - explanatory information for an error when one occurs.
Copy 
{
    "TotalChoices":3,
    "Success":true,
    "Message":""
}

When the choices are deleted successfully, the response contains a status code of 200.

Sort choices

To sort choices, send a PUT request with a URL in the following format:

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

The request contains the following fields:

  • fieldID - the Artifact ID of the field associated with the choices being sorted.
  • sortType - a SortDirection enum indicating how to sort the choices:
    • Ascending
    • Descending
Copy 
{
    "fieldID": 1104635,
    "sortType": "Ascending"
}

The response contains the following fields:

  • TotalChoices - an integer indicating the number of choices sorted.
  • Success - a Boolean value indicating whether the move succeeded.
Copy 
{
    "TotalChoices": 16,
    "Success": true
}

Move choices to the beginning or end of a list

To move choices to the beginning or end of a list, send a PUT request with a URL in the following format:

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

The request contains the following fields:

  • fieldID - the Artifact ID of the field associated with the choices being moved.
  • choiceObjectIdentifiers - contains the following fields:
    • ArtifactID - an integer representing a unique identifier for a choice.
    • Guids - an array of GUIDs used to identify a choice.
  • moveListTo - a ChoiceMoveType enum indicating where to move the choice in the list:
    • Beginning
    • End
Copy 
{
    "fieldID": 1104635,
    "choiceObjectIdentifiers": [
        {
            "ArtifactID": 1104638,
            "Guids": []
        },
        {
            "ArtifactID": 1104637,
            "Guids": []
        }
    ],
    "moveListTo": "End"
}

The response contains the following fields:

  • TotalChoices - an integer indicating the number of choices affected.
  • Success - a Boolean value indicating whether the operation succeeded.
  • Message - explanatory information for an error when one occurs.
Copy 
{
    "TotalChoices":0,
    "Success":true,
    "Message":""
}

Move choices after a specific choice in a list

To move choices after a specific choice in a list, send a PUT request with a URL in the following format:

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

The request contains the following fields:

  • fieldID - the Artifact ID of the field associated with the choices being moved.
  • choiceObjectIdentifiers - contains the following fields:
    • ArtifactID - an integer representing a unique identifier for a choice.
    • Guids - an array of GUIDs used to identify a choice.
  • choiceID - contains the following fields:
    • ArtifactID - an integer representing a unique identifier for a choice.
    • Guids - an array of GUIDs used to identify a choice.
Copy 
{
    "fieldID": 1104635,
    "choiceObjectIdentifiers": [
        {
            "ArtifactID": 1104638,
            "Guids": []
        },
        {
            "ArtifactID": 1104637,
            "Guids": []
        }
    ],
    "choiceID": {
        "ArtifactID": 1104651,
        "Guids": []
    }
}

The response contains the following fields:

  • TotalChoices - an integer indicating the number of choices affected.
  • Success - a Boolean value indicating whether the operation succeeded.
  • Message - explanatory information for an error when one occurs.
Copy 
{
    "TotalChoices":0,
    "Success":true,
    "Message":""
}

Retrieve a list of available parents

You can retrieve a list of parents for a choice or a field.

Retrieve a list of parents for a choice

To retrieve a list of available parents for a choice, send a GET request with a URL in the following format:

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

The request body is empty.

The response contains an array of identifier objects with the following fields:

  • Name - the user-friendly name for the parent.
  • ArtifactID - an integer representing a unique identifier for a parent.
  • Guids - an array of GUIDs used to identify a parent.
Copy 
[
    {
        "Name": "Important",
        "ArtifactID": 1104636,
        "Guids": []
    },
    {
        "Name": "Very",
        "ArtifactID": 1104637,
        "Guids": []
    },
    {
        "Name": "Somewhat",
        "ArtifactID": 1104638,
        "Guids": []
    },
    ...
    {
        "Name": "Privileged",
        "ArtifactID": 1104640,
        "Guids": []
    },
]

Retrieve a list of parents for a field

To retrieve a list of available parents for a specific field, send a POST request with a URL in the following format:

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

The request contains a field identifier object with the following fields:

  • ArtifactID - an integer representing a unique identifier for the field.
  • Guids - an array of GUIDs used to identify the field.
Copy 
{
    "fieldIdentifier": {
        "ArtifactID":1104635,
        "Guids":[]
    }
}

The response contains an array of identifier objects with the following fields:

  • Name - the user-friendly name for the parent.
  • ArtifactID - an integer representing a unique identifier for a parent.
  • Guids - an array of GUIDs used to identify a parent.
Copy 
[
    {
        "Name": "Important",
        "ArtifactID": 1104636,
        "Guids": []
    },
    {
        "Name": "Very",
        "ArtifactID": 1104637,
        "Guids": []
    },
    {
        "Name": "Somewhat",
        "ArtifactID": 1104638,
        "Guids": []
    },
    ...
    {
        "Name": "Privileged",
        "ArtifactID": 1104640,
        "Guids": []
    },
]

Retrieve a list of available colors

To retrieve a list of available colors for highlighting a choice, send a GET request with a URL in the following format:

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

The request body is empty.

The response contains the following fields:

  • Name - a user-friendly name for the color.
  • ID - the identifier for the color.
Copy 
[
    {
        "Name": "Green",
        "ID": 3
    },
    {
        "Name": "Gray",
        "ID": 12
    },
    {
        "Name": "Blue",
        "ID": 13
    },
    {
        "Name": "Orange",
        "ID": 14
    },
    {
        "Name": "Tan",
        "ID": 15
    }
]