Matter Manager service
Through the REST API, the Matter Manager service exposes multiple endpoints that you can use to programmatically manage matters in your Relativity environment. It includes the following features:
- Supports create, read, update, and delete operations on matters.
- Provides helper endpoints used to retrieve available clients and statuses. Use these endpoints to determine the available clients and statuses with which to create or update matters.
This page contains the following information:
- Postman sample file
- Retrieve a list of available clients
- Retrieve a list of available matter statuses
- Create a matter
- Retrieve metadata for a matter
- Update the properties of a matter
- Delete a Matter
Postman sample file
You can use the Postman sample file to become familiar with making calls to endpoints on the Matter Manager service. To download the sample file, click Matter Manager service Postman file.
To get started with Postman, complete these steps:
- Obtain access to a Relativity environment. You need a username and password to make calls to your environment.
- Install Postman.
- Import the Postman sample file for the service. For more information, see Working with data files on the Postman web site.
- Select an endpoint. Update the URL with the domain for your Relativity environment and any other variables.
- In the Authorization tab, set the Type to Basic Auth, enter your Relativity credentials, and click Update Request.
- See the following sections on this page for more information on setting required fields for a request.
- Click Send to make a request.
Retrieve a list of available clients
You can retrieve a list of the available clients in a Relativity environment.
To retrieve a list of available clients, send a GET request to the following URL:
<host>/Relativity.rest/api/relativity.matters/workspace/-1/clients |
The request body is empty.
The response contains the following fields for each server returned in the array:
- Name – the name of the client.
- ArtifactID - the Artifact ID of the client.
Retrieve a list of available matter statuses
You can retrieve a list of available matter statuses in a Relativity environment.
To retrieve a list of matter statuses, send a GET request to the following URL:
<host>/Relativity.rest/api/relativity.matters/workspace/-1/availablestatuses |
The request body is empty.
The response contains the following fields for each server returned in the array:
- Name – the name of the status.
- ArtifactID - the Artifact ID of the status.
Create a matter
Before creating a matter, you need to identify an available client and status to associate with the matter.
To add a new matter to a Relativity environment, send a POST request to this URL:
<host>/Relativity.rest/api/relativity.matters/workspace/-1/matters |
The body of the request must contain the following fields unless specifically identified as optional:
- MatterRequest - represents a request for creating or updating a matter. It includes the following fields:
- Client - indicates the client to be associated with this matter. It includes the following fields:
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Artifact ID for the client.
- Status – indicates the status of the matter:
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Artifact ID of the status.
- Name – the name of the matter.
- Number – indicates the numbered ordering for where to display this matter in a list of matters.
- Keywords - an optional description or other information about the matter.
- Notes - optional words or phrase used to describe the matter.
- Client - indicates the client to be associated with this matter. It includes the following fields:
Retrieve metadata for a matter
You can retrieve basic information about a matter or extended information, which also includes operations that you have permissions to perform on the matter.
- Retrieve basic metadata for a matter - send a GET request to a URL with the following general format:
- Retrieve extended metadata for a matter -send a GET request to a URL with the following general format:
<host>/relativity.rest/api/relativity.matters/workspace/-1/matters/{{Matter ID}} |
<host>/Relativity.rest/api/relativity.matters/workspace/-1/matters/{{Matter ID}}/ true / true |
For both requests, set the {{Matter ID}} variable to the Artifact ID of the matter that you want to read, and leave the bodies of the requests empty.
- Client - indicates the client associated with this matter. It includes the following fields:
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Artifact ID for the client.
- Status – indicates the status of the matter:
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Artifact ID of the status.
- Name – the name of the matter.
- Number – indicates the numbered ordering for where to display this matter in a list of matters.
- CreatedOn - the date and time when the matter was added to Relativity.
- CreatedBy - contains the Artifact ID and name of the user who created the matter
- LastModifiedBy - contains the Artifact ID and name of the user who recently updated the matter.
- LastModifiedOn - the date and time when the matter was most recently modified.
- Keywords - an optional description or other information about the matter.
- Notes - optional words or phrase used to describe the matter.
- Meta - provides additional information available as extended metadata. It includes the following fields:
- Unsupported - a listed of fields not supported on the matter.
- ReadOnly - an array of matter properties that can't be modified, such its name or client.
- Actions - an array of Action objects indicating operations that you have permissions to perform on this matter. For example, you may not have permissions to modify a matter due to your privileges. Each Action object contains the following fields that are available as extended metadata:
- Name - name of an operation available through REST for the matter, such as delete, update, and so on.
- Href - the URL used to make an HTTP request for the operation.
- Verb - the name of the HTTP method for the operation.
- IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this matter.
- Reason - provides an explanation for the unavailability of an action.
Update the properties of a matter
You can modify the properties of a matter, such as its run intervals, enabled property, and others. Additionally, you can also restrict the update of a matter to the date that it was last modified by adding the LastModifiedOn field to the request.
To update the properties of a matter, send a PUT request to a URL with the following general format:
<host>/Relativity.rest/api/relativity.matters/workspace/-1/matters/{{Matter ID}} |
Set the {{Matter ID}} variable to the Artifact ID of the matter that you want to update.
The request must contain the following fields unless specifically identified as optional:
- MatterRequest - represents a request for creating or updating a matter. It includes the following fields:
- Client - indicates the client to be associated with this matter. It includes the following fields:
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Artifact ID for the client.
- Status – indicates the status of the matter:
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Artifact ID of the status.
- Name – the name of the matter.
- Number – indicates the numbered ordering for where to display this matter in a list of matters.
- Keywords - an optional description or other information about the matter.
- Notes - optional words or phrase used to describe the matter.
- Client - indicates the client to be associated with this matter. It includes the following fields:
- LastModifiedOn - the date and time when the matter was most recently modified. This field is only required if you want to restrict the update of a matter to the date that it was last modified. The value must match the LastModifiedOn date for the matter stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.
When the matter is successfully updated, the response returns the status code of 200.
Delete a Matter
You can delete a matter from a Relativity environment if it is not associated with any workspace.
To delete a matter, send a DELETE request to a URL with the following general format:
<host>/Relativity.rest/api/relativity.matters/workspace/-1/matters/{{ToDelete}} |
Set the {{ToDelete}} variable to the Artifact ID of the matter that you want to delete.
The body of the request is empty. When the matter is successfully deleted, the response returns the status code of 200.