Markup Set

A Markup Set resource represents a Relativity markup set available in a workspace. A markup set is a group of securable redactions available to reviewers. You can use the REST API to create, read, update, delete, and query Markup Set objects. For more information, see on Markup Sets in the Relativity Documentation Server2021 site.

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

This page contains the following information:

• GET method
• POST method
• PUT method
• DELETE method

GET method

You can use the GET method to retrieve a single Markup Set or a collection of all Markup Sets 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 Markup Set

When you retrieve a single Markup Set, 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 Markup Set resides, and for the Markup Set itself.

Response

Retrieve all Markup Sets in a workspace

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

Sample URL

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

Response

POST method

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

Query for a Markup Set

You can set conditions used to query for a Markup Set resource.

Sample URL

Request

Response

Create a Markup Set resource

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

Sample URL

Request

Response

PUT method

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

Sample URL

Request

Response

DELETE method

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

Sample URL

Response