Relativity Services API (RSAPI) DTOs have been deprecated and are no longer supported. For more information and alternative APIs, see RSAPI deprecation process.

Layout

A Layout resource represents a Relativity layout available in a workspace. A layout is a form that contains fields used for coding and other purposes. You can use the REST API to read and query Layout objects. For more information, see on Layouts in the Relativity Documentation site.

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

This page contains the following information:

GET method

You can use the GET method to retrieve a single Layout or a collection of all Layouts in a workspace. You can find a general overview of this functionality in Create and update resources and a detailed code sample in Create a simple .NET client.

Retrieve a single Layout

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

Sample URL

This URL includes the Artifact ID for the Workspace where the Layout resides, and for the Layout itself.

  <host>/Relativity.REST/Workspace/1017589/Layout/1036348

Response

Retrieve all Layouts in a workspace

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

Sample URL

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

  <host>Relativity.REST/Workspace/1017589/Layout

Response

POST method

You can use the POST method to perform complex queries for Layout resources. For more information, see Query for resources.

Query for a Layout

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

Sample URL

  <host>/Relativity.REST/Workspace/1017589/Layout/QueryResult

Request

Response