Instance Setting Manager (REST)

The Instance Setting Manager service supports create, read, update, and delete operations in a Relativity environment. With the create endpoint, you can set the value for the instance setting, and its initial or default value. For general information, see Instance settings on the Relativity Documentation site.

Sample use cases for the Instance Setting Manager service include:

  • Updating instance setting values to support behavior implemented by a custom application. You might implement a custom application that sends out email notifications and want to programmatically update the From and To fields on the messages by setting the EmailFrom and EmailTo instance settings.
  • Updating instance setting values to modify or customize existing Relativity behavior. For example, you might want to programmatically change the time frame for running off hour agents by updating the AgentOffHourEndTime and AgentOffHourStartTime instance settings.

You can also use the Instance Setting Manager service through .NET. For more information, see Instance Setting Manager (.NET).

This page contains the following information:

Guidelines for the Instance Setting 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 {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 {Workspace ID} path parameter to -1.

For example, you can use the following URL to retrieve an instance setting:

<host>/Relativity.REST/api/relativity-environment/{versionNumber}/workspaces/-1/instance-settings/{instanceSettingID}

Set the path parameters as follows:

  • {versionNumber} to the version of the API, such as v1.
  • {instanceSettingID} to the Artifact ID of a specific instance setting.

Postman sample file

You can use the Postman sample file to become familiar with making calls to endpoints on the Instance Setting Manager service. To download the sample file, click Instance Setting 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

To use the Instance Setting Manager service, send requests by making calls with the required HTTP methods. See the following base URL for this service:

<host>/Relativity.REST/api/relativity-environment/{versionNumber}/workspaces/-1/instance-settings/

You can use the following .NET code as a sample client for creating an instance setting. This code illustrates how to perform the following tasks:

  • Instantiate an HttpClient object for sending requests to the Instance Setting Manager service.
  • Set the required headers for the request. For information on setting headers, see HTTP headers.
  • Set the url variable to the URL for the admin-level context where the instance setting is to be added. For more information, see Create an instance setting.
  • Set the JSON payload required for the operation.
  • Use the PostAsync() method to send a POST request.
  • Return the results of the request as a string.

Create an instance setting

Instance settings are used to control specific behavior in Relativity, such as query time outs, time frames for running certain agents, and other configuration options. For more information and a list of available settings, see Instance settings on the Relativity Documentation site.

To create an instance setting, send a POST request with a URL in the following general format:

<host>/Relativity.REST/api/relativity-environment/{versionNumber}/workspaces/-1/instance-settings

When a request is successful, the response contains the Artifact ID of the new instance setting, such as 1040499. It also returns the status code of 200.

Read an instance setting

To read an instance setting, send a GET request for the following URL:

<host>/Relativity.REST/api/relativity-environment/{versionNumber}/workspaces/-1/instance-settings/{instanceSettingID}

The request body is empty.

The response for a read operation contains the same fields as those for a create request body. See View field descriptions for a create request.

Update an instance setting

To update an instance setting, send a PUT request with a URL in the following general format:

<host>/Relativity.REST/api/relativity-environment/{versionNumber}/workspaces/-1/instance-settings

The JSON request for the update operation contains the same fields as those for a create request. See View field descriptions for a create request.

When the instance setting is successfully updated, the response returns the status code of 200.

Delete an instance setting

To remove an instance setting from Relativity, send a DELETE request with a URL in the following general format:

<host>/Relativity.REST/api/relativity-environment/{versionNumber}/workspaces/-1/instance-settings/{instanceSettingID}

The request body is empty.

When the instance setting is successfully deleted, the response returns the status code of 200.

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.