Use case: Read an annotation by its identifier

Before you start

Before you read for a specific annotation, ensure you have completed the following prerequisites:

  1. Understand Target Uniqueness: Each annotation is uniquely associated with a specific target in your project. The target represents the exact object, asset, location, or element to which the annotation is attached.
  2. Verify Permissions: Ensure you have the necessary access rights to view the annotation and its related target within your project.
  3. Obtain the Annotation Identifier: You'll need the unique identifier of the annotation object.
  4. Set Up SDK Environment: Confirm that your Unity environment is correctly configured with the Collaboration SDK to interact with the annotation system.
  5. Consider Project Context: Be aware of your project organization to correctly interpret the annotation once found.

How do I...?

Read an annotation by its identifier

To retrieve the annotation by its identifier, follow these steps:

  1. Prepare the Project Identifier: Ensure you have the correct project identifier (GUID) for the project you want to search for.
  2. Prepare the Annotation Identifier: Ensure you have the correct annotation identifier (GUID) for the annotation you want to find.
  3. Execute Search: Use the SDK to search for the annotation.

Example:

IAnnotation result = await annotationManagement.ReadAnnotationAsync(projectId, annotationId, cancellationToken);

For related annotation operations, see documentation on updating an annotation and finding replies to an annotation.