Annotations Manager (.NET)

In Relativity, markups refer to redactions and highlights that you can add to document images as part of the review process in the Image Viewer. A redaction obscures confidential content in an image, while a highlight visually emphasizes content. You can define the colors and styles used to add markups to a document image. For more information, see Image Viewer and Markups in the RelativityOne Documentation site.

The Annotations Manager API exposes functionality for programmatically redacting and highlighting document images. It contains methods for creating, updating, retrieving, and deleting redactions and highlights.

As a sample use case, you might use this API in application that provides custom functionality for adding redactions or highlights to document images. You might include the ability to delete multiple redactions in a single operation.

You can also use the Annotations Manager API through REST. For more information, see Annotations Manager (REST).

Note: The following content uses the term annotations to reference redactions or highlights added to document images through the Image Viewer.

This page contains the following information:

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

Fundamentals for the Annotations Manager API

Review the following information to learn about the methods and classes used by the Annotations Manager API.

Create or update annotations

Use the Save() method to add annotations to a document image or to update existing ones. Pass the following arguments to this method:

  • workspaceId - the Artifact ID of the workspace containing the document image with annotations.
  • annotation - an array of Annotation objects. For a list of properties, see Classes.
  • Note: When updating an annotation, set the ID property on each Annotation object in the array.

Retrieve annotations on a document

Use the Get() method to retrieve a list of annotations on a document image. Pass the following arguments to this method:

  • workspaceId - the Artifact ID of the workspace containing the document image with annotations.
  • documentId - the Artifact ID of the document image with annotations.
  • markupSetId - the Artifact ID of the markup set used to add the annotations.

Delete annotations from a document

Use the Delete() method to remove annotations on a document. Pass the following arguments to this method:

  • workspaceId - the Artifact ID of the workspace containing the document image with annotations.
  • annotationIds - an array of integer IDs representing the annotations on the document image.
  • documentId - the Artifact ID of the document image with annotations.
  • markupSetId - the Artifact ID of the markup set used to add the annotations.

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.