Mass Operation Manager (REST)

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.

The following code sample demonstrates how to make REST calls against the Mass Operation service. In this example we create a custom page mass operation.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
using (HttpClient client = new HttpClient())
{
    client.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
    client.DefaultRequestHeaders.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("test@test.com:SomePassword!")));
    client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0");
    client.BaseAddress = new Uri("https://localhost/");
    int workspaceID = 1022092;
 
    string url = $"/Relativity.Rest/api/relativity-extensibility/{versionNumber}/workspaces/{workspaceID}/mass-operations/custom-page-mass-operations";
    string inputJSON = @"{""MassOperationRequest"": {""Name"": ""My Mass Op"",""ObjectType"": { ""Name"": ""My RDO"" },""Url"": ""www.custompagemassop.net"",""PopupHeight"": 500,""PopupWidth"": 500}}";
    using (HttpResponseMessage response = await client.PostAsync(url, new StringContent(inputJSON, Encoding.UTF8, "application/json")))
    {
        response.EnsureSuccessStatusCode();
    }
}

To create a mass operations that displays a custom page for a user, send a POST request to the following URL:

1
<host>/Relativity.Rest/api/relativity-extensibility/{versionNumber}/workspaces/{workspaceID}/mass-operations/custom-page-mass-operations

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to create a mass operation. It contains the following fields:
  • Name - the user-friendly name of the mass operation.
  • ObjectType - contains information about the object type to associate with this mass operation. Only the Artifact ID of the object type is required.
  • Url - the URL for the custom page that you want displayed as a pop-up window for the mass operation.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application.
  • PopupHeight - the height of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.
  • PopupWidth - the width of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.

1
2
3
4
5
6
7
8
9
10
11
12
{
    "MassOperationRequest": {
        "Name": "My Mass Op",
        "ObjectType": {
            "Name": "My RDO"
        },
        "Url": "www.custompagemassop.net",
        "RelativityApplications": []
        "PopupHeight": 500,
        "PopupWidth": 500
    }
}

To create a mass operation that executes an event handler, send a POST request to the following URL:

1
2
<host>/Relativity.Rest/api/relativity-extensibility/{versionNumber}/workspaces/{workspaceID}/mass-operations/event-handler-mass-operations

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to create a mass operation. It contains the following fields:
  • Name - the user-friendly name of the mass operation.
  • ObjectType - contains information about the object type to associate with this mass operation. Only the Artifact ID of the object type is required.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application.
  • EventHandlerID - identifier of event handler to invoke for this mass operation.
  • Layout - represents identification information for a layout. It contains the following field:
    • Value - contains the Artifact ID and GUIDs used to identify a specific layout for the mass operation. The array containing GUIDs can be empty.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "MassOperationRequest": {
        "Name": "Mass Op Name",
        "ObjectType": {
            "Name": "My RDO"
        },
        "RelativityApplications": [],
        "EventHandlerID": 8675309,
        "Layout": {
            "Value": {
                "ArtifactID": 3456789,
            }
        }
    }
}

To update a custom page mass operation, send a PUT request to the following URL:

1
<host>/Relativity.Rest/api/relativity-extensibility/{versionNumber}/workspaces/{workspaceID}/mass-operations/custom-page-mass-operations/{massOperationID}

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to update a mass operation. It can contain the following fields:
  • Name - the user-friendly name of the mass operation.
  • Url - the URL for the custom page that you want displayed as a pop-up window for the mass operation.
  • PopupHeight - the height of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.
  • PopupWidth - the width of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application.
  • LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of a mass operation to the date that it was last modified. The value must match the LastModifiedOn date for the mass operation stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

1
2
3
4
5
6
7
8
9
10
11
{
    "MassOperationRequest": {
        "Name": "My custom page mass operation",
        "ObjectType": {
            "Name": "My RDO"
        },
        "Url": "www.mycustompage.net",
        "PopupHeight": 500,
        "PopupWidth": 500
    }
}

To update an event handler mass operation, send a PUT request to the following URL:

1
<host>/Relativity.Rest/api/relativity-extensibility/{versionNumber}/workspaces/{workspaceID}/mass-operations/event-handler-mass-operations/{massOperationID}

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to update a mass operation. It contains the following fields:
  • Name - the user- friendly name of the mass operation.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application.
  • EventHandlerID - identifier of event handler to invoke for this mass operation.
  • Layout - represents identification information for a layout. It contains the following field:
    • Value - contains the Artifact ID and GUIDs used to identify a specific layout for the mass operation.
  • LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of a mass operation to the date that it was last modified. The value must match the LastModifiedOn date for the mass operation stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "MassOperationRequest": {
        "Name": "Mass Op Name",
        "ObjectType": {
            "Name": "My RDO"
        },
        "RelativityApplications": [],
        "EventHandlerID": 8675309,
        "Layout": {
            "Value": {
                "ArtifactID": 4444445,
            }
        }
    }
}

When a mass operation is successfully updated, the response returns a status code of 200.