Get an annotation

Retrieves the referenced annotation.

The caller must have read-access on the annotated resource, otherwise the call will fail.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
annotationId
required
integer <int64> (AnnotationId) [ 1 .. 9007199254740991 ]

The internal ID of the annotation

Example: 4096
Responses
200

Successful retrieval

400

The response for a failed request.

get/annotations/{annotationId}
Request samples 
const annotationIds = [{ id: 1 }, { id: 2 }];

const response = await client.annotations.retrieve(annotationIds);
Response samples
application/json
{
  • "id": 4096,
  • "createdTime": 1730204346000,
  • "lastUpdatedTime": 1730204346000,
  • "annotatedResourceType": "file",
  • "annotatedResourceId": 1337,
  • "annotationType": "pointcloud.BoundingVolume",
  • "creatingApp": "cognite-vision",
  • "creatingAppVersion": "1.2.1",
  • "creatingUser": "john.doe@cognite.com",
  • "data": {
    • "assetRef": {
      },
    • "symbolRegion": {
      },
    • "textRegion": {
      },
    • "pageNumber": 43
    },
  • "status": "approved"
}
➔ Next to Retrieve annotations