Choice Manager service

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 in the Relativity Services API. For more information, see Choice in the Services API documentation.

This page contains the following information:

Sample URL

The following is the base URL for sending a request to the Choice Manager service by making a call to an endpoint with the required HTTP method.

<host>/Relativity.Rest/API/Relativity.Choices/workspace/{workspaceID}/

The following is a sample URL for sending a request to the Choice Manager service. Set the workspaceID variable to the Artifact ID of the workspace where you want to add a new choice.

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/

Create

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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/

The following is a sample URL for sending a POST request to the Choice Manager service. Set the workspaceID variable to the Artifact ID of the workspace where you want to add a new choice. Mandatory fields in the request: Field, Name, and Color.

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/ 
{
    "choiceRequest":{
        "Field": {
            "ArtifactID": 1039534
        },
        "Name":"Test workspace 2",
        "Color": 3,
        "Parent": {
            "ArtifactID": 1003663
        },
        "Order": 700,
        "KeyboardShortcut": {
            "Shift": false,
            "Ctrl": true,
            "Alt": false,
            "Key": 15
        },
        "Keywords": "",
        "Notes": "", 
		"RelativityApplications": [
			{"ArtifactID": 1177979}
		]
    }
}

The response is an Artifact ID of the created Choice. A status code of 200 is also returned when the request is successful.

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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/
{
    "massCreateChoiceRequest":{
        "Choices":[
            {
                "Name":"Choice 1",
                "Children":[
                    {
                        "Name":"Choice 1.1",
                        "Children":[]
                    }
                ]
            },
            {
                "Name":"Choice 2",
                "Children":[]
            }
        ],
        "ChoiceTemplateData":{
            "Field":{
                "ArtifactID": 1321302
            },
            "RelativityApplications": [],
            "Keywords":"",
            "Notes":"",
        }
    }
}
{
    "ChoicesCreated": [
        {
            "Name": "Choice 1",
            "ArtifactID": 1025647,
            "Guids": []
        },
        {
            "Name": "Choice 2",
            "ArtifactID": 1025648,
            "Guids": []
        }
    ],
    "Success": true,
    "Message": ""
}

Read

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 basic metadata: 

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/{choiceID}|{ChoiceGUID}

Set the workspaceID and the choiceID variable to the Artifact ID of the choice. See the following sample URL:

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/1015348

Set the workspaceID and the ChoiceGUID variable to the Artifact ID of the choice. See the following sample URL:

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/56D5E0CD-194D-4679-9CB4-995A697429BF


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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/{choiceID}|{ChoiceGUID}/{includeMetadata}/{includeActions}

Set the workspaceID and choiceID | ChoiceGUID variables, and then set both the includeMetadata and includeActions variables to true. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/56D5E0CD-194D-4679-9CB4-995A697429BF/true/true

{
    "Field": {
        "Name": "State",
        "ArtifactID": 1017424,
        "Guids": []
    },
    "Order": 20,
    "Color": {
        "ID": 3
    },
    "Parent": {
        "ArtifactID": 62,
        "Guids": []
    },
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "CreatedOn": "2019-03-04T23:05:35.297",
    "CreatedBy": {
        "Name": "Service Account, Relativity",
        "ArtifactID": 777,
        "Guids": []
    },
    "LastModifiedBy": {
        "Name": "Service Account, Relativity",
        "ArtifactID": 777,
        "Guids": []
    },
    "LastModifiedOn": "2019-03-04T23:05:35.297",
    "Keywords": "",
    "Notes": "",
    "Meta":{
        "Unsupported":[],
        "ReadOnly":[]
    },
    "Actions": [
    {
        "Name": "Delete",
        "Href": "Relativity.Choices/workspace/-1/choice/56d5e0cd-194d-4679-9cb4-995a697429bf",
        "Verb": "DELETE",
        "IsAvailable": true,
        "Reason": []
    },
    {
        "Name": "Update",
        "Href": "Relativity.Choices/workspace/-1/choice/56d5e0cd-194d-4679-9cb4-995a697429bf",
        "Verb": "PUT",
        "IsAvailable": true,
        "Reason": []
    },
    {
        "Name": "Create",
        "Href": "",
        "Verb": "",
        "IsAvailable": true,
        "Reason": []
    }],
    "Name": "InProgress",
    "ArtifactID": 1017426,
    "Guids": [
        "56d5e0cd-194d-4679-9cb4-995a697429bf"
    ]
}

Update

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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/{choiceID}|{ChoiceGUID}

The following is a sample URL for sending a PUT request to the Choice Manager service. Set the workspaceID and the choiceID variable to the Artifact ID of the choice.

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/1015348

Set the workspaceID and the ChoiceGUID variable to the Artifact ID of the choice. See the following sample URL:

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/56D5E0CD-194D-4679-9CB4-995A697429BF

{
    "ChoiceRequest": {
        "Name":"Updated choice",
        "Color": 3,
        "Order":700,
        "Keywords": "",
        "Notes": "",
        "KeyboardShortcut": {
            "Alt": false,
            "Ctrl": true,
            "Shift": false,
            "Key": 14
        },
        "Parent": {
            "ArtifactID": 62,
            "Guids": []
        },
        "RelativityApplications":[]
    }
}

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


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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/

Set the workspaceID variable to the Artifact ID of the choice. See the following sample URL:

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/
{
    "massUpdateChoices":[
        {
            "ArtifactID":1024178,
            "Name":"Massive Update 1",
            "Color": 3,
            "Keywords": "",
            "Notes": "",
            "RelativityApplications":[]
        },
        {
            "ArtifactID":1024179,
            "Name":"Massive Update 2"
        }
    ]
}
{
    "TotalChoices": 1,
    "Success": true,
    "Message": ""
}

Delete

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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/{choiceID}|{ChoiceGUID}

Set the workspaceID and the choiceID variable to the Artifact ID of the choice. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/1015348

Set the workspaceID and the ChoiceGUID variable to the Artifact ID of the choice. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/56D5E0CD-194D-4679-9CB4-995A697429BF

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


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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/

Set the workspaceID variable to the Artifact ID of the choice. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/

{
    "massDeleteRequest":{
        "ChoiceIDs":[
            {
                "ArtifactID":1088639
            },
            {
                "ArtifactID":1088632
            }
        ]
    }
}
{
    "TotalChoices": 1,
    "Success": true,
    "Message": ""
}

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

Sort

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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/sort

Set the workspaceID variable to the Artifact ID of the choice. Use "SortType" 0 for ascending sort and 1 for descending sort. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/sort

{
    "FieldID":1039591,
    "sortType":1
}
{
    "TotalChoices": 1,
    "Success": true,
    "Message": ""
}

 

Move a choice

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

<host>/Relativity.rest/api/Relativity.Choices/workspace/{WorkspaceID}/choice/move

Set the workspaceID variable to the Artifact ID of the choice. Use "moveListTo" 0 to move a choice to the beginning and 1 to move a choice to the end. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/move
{
    "FieldID":1017391,
    "choiceObjectIdentifiers":[
    {
        "ArtifactID":1017392
    },
    {
        "ArtifactID":1017397
    }],
    "moveListTo":1
}
{
    "FieldID":1017391,
    "choiceObjectIdentifiers":[
        {
            "ArtifactID":1017392
        },
        {
            "ArtifactID":1017397
        }
    ],
    "choiceID":{
        "ArtifactID":1017398
    }
}

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.Choices/workspace/{WorkspaceID}/choice/{choiceID}|{ChoiceGUID}/parents

Set the workspaceID and the choiceID variable to the Artifact ID of the choice. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/1015348/parents

Set the workspaceID and the ChoiceGUID variable to the Artifact ID of the choice. See the following sample URL: 

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/56D5E0CD-194D-4679-9CB4-995A697429BF/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.Choices/workspace/{WorkspaceID}/choice/parents

Set the workspaceID variable. See the following sample URL:

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/parents
{
    "fieldIdentifier": {
        "ArtifactID": 1065489,
        "Guids": ["8F6DF0BA-199B-4569-2CB4-755A697984BC"]
    }
}
[
    {  
        "ArtifactID": 1065489,
        "Guids": ["8F6DF0BA-199B-4569-2CB4-755A697984BC"]
    },
    {
        "ArtifactID": 1056985,
        "Guids": []
    }
]

Retrieve a list of available colors

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.Choices/workspace/{WorkspaceID}/choice/colors

Set the workspaceID variable. See the following sample URL:

<host>/Relativity.Rest/API/Relativity.Choices/workspace/1021354/choice/colors

[
    {
        "Name": "Green",
         "ID": 1065482
    },
    {
        "Name": "Yellow",
        "ID": 1065483
    }
]