Use case: Remove field from annotation metadata

Before you start

  1. Verify Permissions: Check that you have the required permissions to edit annotations. Typically, this requires either being the annotation creator or having administrator privileges.
  2. Identify the Annotation: Make sure you have the unique identifier of the annotation you wish to edit. You'll need this ID to reference the specific annotation in your request.
  3. Consider Data Retention: Be aware that removing a metadata field is permanent and cannot be undone. Ensure you want to remove this content completely from the system.

How do I...?

Remove a metadata field

To remove a metadata field, follow these steps:

  1. Retrieve the Project ID: Before removing a metadata field, ensure you have the correct Project ID.
  2. Retrieve the Annotation ID: Before removing a metadata field, ensure you have the correct annotation ID. You can get this from search results or from a specific annotation view.
  3. Call the Remove Method: Use the SDK's method to remove the field from annotation metadata from the system.
  4. Handle Confirmation and Errors: Your implementation should verify whether the remove was successful and handle any potential errors appropriately.
  5. Update UI: If your application has a user interface displaying metadata, refresh the view to reflect the changes.

Example:

List<string> metadataFields = new List<string>() { "metadataField_1", "metadataField_2" };

await annotationManagement.RemoveFieldsFromAnnotationMetadataAsync(projectId, annotationId, metadataFields, cancellationToken);

For more information on managing annotations, refer to related documentation on Create an annotation or Update an annotation.