Production Placeholder Manager (REST)

In Relativity, a placeholder is an image or custom text that you can add to a production. It may indicate that content is withheld due to privilege or it may contain additional information about a document. For general information, see Production placeholders on the RelativityOne Documentation site.

The Production Placeholder Manager API supports the following functionality:

  • CRUD operations on placeholders
  • Retrieving default field values for a placeholder

You can also use the Production Placeholder Manager API through .NET. For more information, see Production Placeholder Manager (.NET).

This page contains the following information:

See these related pages:

Guidelines for productions in REST

Review the following guidelines for working with this service.

URLs

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set {versionNumber} to the version of the API, using the format lowercase v and the version number, such as v1.
  • Set other path parameters in the URLs to the Artifact ID of a given entity, such as {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

The following example illustrates how to set the path parameters when deleting a data source, but the same convention applies to all URLs in the Production APIs:

<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/production-data-sources/{DataSourceID}

Set the path parameters as follows:

  • {versionNumber} to the version of the API, such as v1.
  • {WorkspaceID} to the Artifact ID of the workspace that contains the data source.
  • {DataSourceID} to the Artifact ID of a specific data source.

Create a placeholder

To add a new placeholder to Relativity, send a POST request with a URL in the following format:

<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/production-placeholders

When the placeholder is successfully created, the response contains its Artifact ID.

1051085

Retrieve a placeholder

To read a placeholder, send a GET request with a URL in the following format:

<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/production-placeholders/{PlaceholderID}

The request body is empty.

Update a placeholder

To modify a placeholder, send a PUT request with a URL in the following format:

<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/productions/reproduction-jobs/{ReproductionJobID}/stage-and-run

When the placeholder is successfully updated, the response returns a status code of 200.

Delete a placeholder

To remove a placeholder from Relativity, send DELETE request with a URL in the following format:

<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/production-placeholders/{PlaceholderID}

The request body is empty.

When the placeholder is successfully deleted, the response returns a status code of 200.

Retrieve default field values for a placeholder

To retrieve default field values for a placeholder, send a GET request with a URL in the following format:

<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{workspaceID}/production-placeholders/defaults

Note: This endpoint doesn't return empty or null fields.

The request body is empty.

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.