Cold Storage Manager (REST)

The Cold Storage Manager service exposes endpoints for programmatically managing workspaces in Relativity cold storage. It includes the following features:

• Moving workspaces in or out of cold storage
• Deleting workspaces in cold storage
• Provides endpoints that help to determine:
  • if a given workspace is in cold storage
  • if users have permission to manage cold storage workspaces

As a sample use case, you might use the Cold Storage Manager service to automatically move workspaces in and out of cold storage, or keep track of the workspaces in cold storage in a Relativity application developed for your organization.

You can also access the Cold Storage Manager service through NET. For more information, see Cold Storage Manager (.NET).

Postman sample file

You can use the Postman sample file to become familiar with making calls to endpoints on the Cold Storage Manager service. To download the sample file, click Cold Storage 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 send a request to the Cold Storage Manager service by making a call to an endpoint with the required HTTP method. See the following base URL for this service:

1
<host>/Relativity.Rest/API/cold-storage/{versionNumber}/workspaces/{workspaceID}/status/in

Set the path parameters:

• {versionNumber}: to the version of the API, such as v1
• {WorkspaceID}: to the Artifact ID of the workspace

Move Workspace Into Cold Storage

To move a workspace into cold storage, send a POST request with a URL in the following format:

URL for endpoint

1
<host>/Relativity.Rest/API/cold-storage/{versionNumber}/workspaces/{workspaceID}/status/in

Raw JSON request

1
EMPTY

Raw JSON response

1
2
3
4
{
    "WorkspaceID": xxxxxxx,
    "Status": "In"
}

Move Workspace Out Of Cold Storage

To move a workspace out of cold storage, send a POST request with a URL in the following format:

URL for endpoint

1
<host>/Relativity.Rest/API/cold-storage/{versionNumber}/workspaces/{workspaceID}/status/out

Raw JSON request

1
EMPTY

Raw JSON response

1
2
3
4
{
    "WorkspaceID": xxxxxxx,
    "Status": "MovingOut"
}

Get Workspace Cold Storage Status

To get workspace cold storage status, send a GET request with a URL in the following format:

Client code sample:

1
<host>/Relativity.Rest/API/cold-storage/{versionNumber}/workspaces/{workspaceID}/status

Raw JSON request

1
EMPTY

Raw JSON response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "WorkspaceID": xxxxxxx,
    "Status": "MovingOut",
    "ActivationJobSubmittedBy": {
        "Secured": false,
        "Value": {
            "ArtifactID": xxx,
            "Guids": []
        }
    },
    "ActivationJobSubmittedOnUtc": "2022-12-15T11:59:12.24",
    "AddedToColdStorageOnUtc": "2022-12-15T11:56:32.86"
}

Delete Workspace From Cold Storage

To use this endpoint, you must have the following:

• View and Delete permissions for the workspace set at the workspace level. See Workspace security on the Documentation site.

Workspaces must be in cold storage for at least 30 days, otherwise an error is thrown.

To delete a workspace in cold storage status, send a DELETE request with a URL in the following format:

Client code sample:

1
<host>/Relativity.Rest/API/cold-storage/{versionNumber}/workspaces/{workspaceID}

Raw JSON request

1
EMPTY

Raw JSON response

1
EMPTY

Manage Cold Storage

To check if you can manage cold storage, send a Get request with a URL in the following format:

1
<host>/Relativity.Rest/API/cold-storage/{versionNumber}/workspaces/{workspaceID}/has-manage-permissions

Raw JSON request

1
EMPTY

Raw JSON response

1
true|false