Instance Setting Manager service

Through the REST API, 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:

You can also use the Instance Setting Manager service through the .NET, which supports the same functionality available through REST. For more information, see Instance Setting Manager API.

This page contains the following information:

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.InstanceSettings/workspace/-1/instancesettings/

Note: For the workspace identifier in the URL, use -1 to indicate the admin-level context. This value is required for all URLs in the Instance SettingManager service.

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:

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 to the following URL:

<host>/Relativity.REST/api/Relativity.InstanceSettings/workspace/{{workspaceID}}/instancesettings/

Set the {{workspaceID}} variable to -1 for the admin-level context.

The body of the request contains the following fields:

{
   "instanceSetting":{
      "Name":"Sample Instance Setting name",
      "Section":"Sample Instance Setting section",
      "Machine":"",
      "ValueType":"Text",
      "Value":"Sample text value!",
      "InitialValue":"Sample initial value",
      "Encrypted":false,
      "Description":"Sample description",
      "Keywords":"Sample keywords",
      "Notes":"Sample notes"
   }
}

When a request is successful, the response contains the Artifact ID of the new instance setting, such as 1023057. 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.InstanceSettings/workspace/{{workspaceID}}/instancesettings/{{instanceSettingID}}

Set the {{workspaceID}} variable to -1 for the admin-level context, and set the {{instanceSettingID}} variable to the Artifact ID of the instance setting.

Body of the request is empty.

The response for a read operation contains the same fields as those for a create request. See Create an instance setting. It also includes the following fields:

Update an instance setting

To update an instance setting, send a PUT request to the following URL:

<host>/Relativity.REST/api/Relativity.InstanceSettings/workspace/{{workspaceID}}/instancesettings/

Set the {{workspaceID}} variable to -1 for the admin-level context.

The JSON request for the update operation contains the same fields as those for a create request. See Create an instance setting. It also includes these fields:

Note: You can only update the Machine, Value, Encrypted, Keywords and Notes fields. All other fields must have the same values as those specified in the create request, or returned by a read request.

{
   "instanceSetting":{
      "ArtifactID":1023057,
      "Name":"Sample Instance Setting name",
      "Section":"Sample Instance Setting section",
      "Machine":"",
      "ValueType":1,
      "Value":"Sample text value!",
      "InitialValue":"Sample initial value",
      "Encrypted":false,
      "Description":"Sample description",
      "Keywords":"Sample keywords",
      "Notes":"Sample notes"
   }
}

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 to the following URL:

<host>/Relativity.REST/api/Relativity.InstanceSettings/workspace/{{workspaceID}}/instancesettings/{{instanceSettingID}}

Set the {{workspaceID}} variable to -1 for the admin-level context, and set the {{instanceSettingID}} variable to the Artifact ID of the instance setting.

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

Community Updates

Aero Developer FAQ Evolving the Platform Most recent release notes
Learn more Learn more Learn more

Additional Resources

   
Access Third-Party Tools with GitHub     Create .NET Apps Faster with NuGet
Visit github     visit nuget