Production Placeholder Manager (.NET)

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 REST. For more information, see Production Placeholder Manager (REST).

This page contains the following information:

See these related pages:

The Relativity.Productions.Client contains this API. For compatibility and package installation instructions, see Download the SDKs and NuGet packages.

Fundamentals for the Production Placeholder Manager API

The Production Placeholder Manager API contains the following methods, classes, and enumerations.

For reference content, see Productions API.

Create a placeholder

Use the CreateSingleAsync() method to add an image or custom placeholder to a specific workspace. When you create a production placeholder, you can upload image data for the placeholder as the FileData property, or use HTML-formatted text as the CustomText property. These inputs are converted to a JPG and are stored in a file type field on the ProductionPlaceholder object.

Note: You must have the permissions for working with placeholders.

Pass the following arguments to the CreateSingleAsync() method:

  • workspaceID - the Artifact ID of the workspace containing the placeholder.
  • placeholder - a ProductionPlaceholder object specifying the properties for the placeholder. Use these guidelines to specify an image or custom placeholder:
    • If you set the PlaceholderType property to Custom, you must also set the CustomText property. You can create a blank placeholder by setting the CustomText property to an empty string.
    • If you set the PlaceholderType property to Image, you must also set the FileData and Filename properties. The FileData property must contain raw Base64 encoded image data.

This method returns the Artifact ID of the new placeholder.

Read a placeholder

Use the ReadSingleAsync() method to retrieve a production placeholder. Pass the Artifact IDs of the workspace and the placeholder to this method.

This method returns a ProductionPlaceholder object. You can inspect this object for information such as the PlaceholderType property, which indicates whether the the placeholder is an image or custom text.

Update a placeholder

Use the UpdateSingleAsync() method to modify an image placeholder or a custom placeholder in a specific workspace.

Note: You can't modify the PlaceholderType property for an existing placeholder.

Delete a placeholder

Use the DeleteSingleAsync() method to remove a placeholder from Relativity. Pass the Artifact IDs of the workspace and the placeholder to this method.

Note: You can delete placeholders that are currently in use by data sources.

Retrieve default field values for a placeholder

Use the GetProductionPlaceholderDefaultFieldValues() method to retrieve default field values for a production placeholder in a specific workspace. This method doesn't return empty or null fields.

Pass the Artifact ID of the workspace containing the placeholder to this method.

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.