Annotations

Get an annotation

Returns information about a single annotation that is based on its unique ID.

get/annotations/{annotationId}

Request

  • Base URL: http://example.com/annotations
  • URL: http://example.com/annotations/annotations/{annotationId}
  • Auth: none declared

Path parameters

annotationIdstring required

The annotation ID.

Response

The annotation exists.

versionnumber

The version of the resource.

idstring

The unique ID, which the system assigns.

domainstring

The domain that is associated with the annotation. The domain and name comprise a unique key.

namestring

The name. The domain and name comprise a unique key.

labelstring

The display label for the annotation.

descriptionstring

The description.

createdBystring

The user who created this annotation member.

modifiedBystring

The last user to modify this annotation member.

creationTimeStampstring

The formatted timestamp when the annotation member was created, shown in yyyy-mm-ddThh:mm:ssZ format.

modifiedTimeStampstring

The formatted timestamp when the annotation member was last modified, shown in yyyy-mm-ddThh:mm:ssZ format.

Changes

No recorded changes to this operation across all 1 revision of this API.