RSAPI reference for REST

The REST API reference section includes basic information about how to work with admin- and workspace-level Relativity resources. It provides the following samples, which illustrate how you can perform tasks with select resources:

• C# code samples – These samples illustrate how to instantiate an HttpClient instance for sending and receiving HTTP messages through the REST API. They also illustrate how to set required headers, call supported HTTP methods on resources, and parse the JSON representations returned in responses; or deserialize JSON to Relativity DTOs (in .NET client implementations). For additional code samples, see Create a simple .NET client.
• JSON representations – These resource representations are provided for both sample requests and responses. They illustrate the JSON format (including required fields) used for representing common Relativity objects. For more information, see JSON representations and Constant Field names.

Note: For information on authentication including authentication providers, OAuth2 clients, federated instances, and related topics, see User authentication and REST API authentication.

DTO	Supported operations
	Create	Read	Update	Delete	Query
Batch		✓	✓		✓
Batch Set	✓	✓	✓	✓	✓
Choice		✓			✓
Document	✓	✓	✓	✓	✓
Error	✓
Field	✓	✓		✓	✓
Group	✓	✓	✓	✓	✓
Layout		✓			✓
Markup Set	✓	✓	✓	✓	✓
Matter	✓	✓	✓	✓	✓
ObjectType	✓	✓	✓	✓	✓
RelativityApplication		✓			✓
Relativity Dynamic Object (RDO)	✓	✓	✓	✓	✓
RelativityScript		✓			✓
Tab		✓			✓
User	✓	✓	✓	✓	✓
Workspace		✓			✓

Note: While the REST API supports CRUDQ operations on many Relativity resource types, there is no full feature parity between the REST and the Services API, and certain operations supported by the Services API are not supported in the REST API, for example, DTO helper methods or script execution.