This DTO has been deprecated as part of the Relativity Services API (RSAPI) Deprecation and is no longer supported. For more information and alternative APIs, see RSAPI deprecation process.

Group

A Group resource represents a Relativity group available in a workspace. A group contains a selection of users with specific permissions. You can use the REST API to create, read, update, delete, and query Group objects. For more information, see on Groups in the Relativity Documentation site.

You can also interact with Group objects through the Relativity Services API. For more information, see Group under RSAPI reference for .NET.

This page contains the following information:

GET method

You can use the GET method to retrieve a single Group or a collection of all Groups in a workspace. You can find a general overview of this functionality in Create and update resources.

Retrieve a single Group

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

Sample URL

Copy 
<host>/Relativity.REST/Relativity/Group/1015025

Response

Retrieve all Groups in a workspace

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

Sample URL

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

Copy 
<host>/Relativity.REST/Relativity/Group

Response

POST method

You can use the POST method to perform complex queries or to create Group resources. For more information, see Query for resources and Create and update resources.

Query for a Group

You can set conditions used to query for a Group resource.

Sample URL

Copy 
<host>/Relativity.REST/Relativity/Group/QueryResult

Request

Response

Create a Group resource

You can create a Group with a POST method. For more information, see Create and update resources.

Sample URL

Copy 
<host>/Relativity.REST/Relativity/Group

Request

Response

PUT method

You can use the PUT method to update properties on a Group. For more information, see Create and update resources.

Sample URL

Copy 
<host>/Relativity.REST/Relativity/Group/1017724

Request

Response

DELETE method

You can use the DELETE method to remove a Group from a Relativity workspace. You don't need to provide a body with a DELETE request.

Sample URL

Copy 
<host>/Relativity.REST/Relativity/Group/1017724

Response