New: build custom CDF applications with Cognite Flows. Documentation · What's new.
const annotationIds = [{ id: 1 }, { id: 2 }];
const response = await client.annotations.retrieve(annotationIds);{
"items": [
{
"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": {
"externalId": "abc"
},
"symbolRegion": {
"xMin": 0.1,
"xMax": 0.2,
"yMin": 0.1,
"yMax": 0.2
},
"textRegion": {
"xMin": 0.2,
"xMax": 0.3,
"yMin": 0.2,
"yMax": 0.3
},
"pageNumber": 43
},
"status": "approved"
}
]
}Retrieves the referenced annotations.
The caller must have read-access on all the annotated resources, otherwise the call will fail.
const annotationIds = [{ id: 1 }, { id: 2 }];
const response = await client.annotations.retrieve(annotationIds);{
"items": [
{
"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": {
"externalId": "abc"
},
"symbolRegion": {
"xMin": 0.1,
"xMax": 0.2,
"yMin": 0.1,
"yMax": 0.2
},
"textRegion": {
"xMin": 0.2,
"xMax": 0.3,
"yMin": 0.2,
"yMax": 0.3
},
"pageNumber": 43
},
"status": "approved"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
A request referencing existing annotations
A list of existing annotation references
Show child attributes
Successful retrieval
A list of annotations
Show child attributes
Was this page helpful?