Relativity Script

A Relativity Script resource represents a script deployed into a Relativity workspace. You can use the REST API to read and query the already existing scripts that have been imported from the Relativity Script Library or manually created. You can also interact with Relativity scripts through the Services API. For general information about scripts, see the Relativity Documentation site.

This page contains the following information:

• GET method
• POST method

GET method

You can use the GET method to retrieve all Scripts in a Relativity workspace or a single Script. You can find a general overview of this functionality in Retrieve resources and a detailed code sample in Create a simple .NET client.

Retrieve all workspace Scripts

You can retrieve a collection of all Scripts in a workspace with a GET method.

Sample URL

The URL indicates that you are retrieving a collection of Relativity Script resources. You don't need to provide a body with this GET request.

Response

Retrieve a single Script

When you retrieve a single Relativity Script, you must supply a unique identifier (such as a GUID or ArtifactID) for the resource.

Sample URL

The URL contains the identifier for a Relativity Script resource. You don't need to provide a body with a GET request.

Response

POST method

You can use the POST method to perform complex queries for Relativity Scripts. For detailed information about Relativity REST API query syntax, see Perform queries.

Query for a Script resource

You can set conditions used to query for a Relativity Script resource.

Sample URL

Request

Response