const annotatedFileId = 1;
const limitOne = await client.annotations.list({
limit: 1,
filter: {
annotatedResourceType: 'file',
annotatedResourceIds: [{ id: 1 }],
},
});{
"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"
}
],
"nextCursor": null
}Lists the annotations the caller has access to, based on a filter.
The caller must have read-access on the annotated resources listed in the filter, otherwise the call will fail.
const annotatedFileId = 1;
const limitOne = await client.annotations.list({
limit: 1,
filter: {
annotatedResourceType: 'file',
annotatedResourceIds: [{ id: 1 }],
},
});{
"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"
}
],
"nextCursor": null
}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 specifying the annotation listing behavior
A filter to apply on annotations
Show child attributes
{
"annotatedResourceType": "file",
"annotatedResourceIds": [{ "id": 1066 }, { "id": 1067 }],
"status": "approved",
"data": { "label": "cat" }
}A cursor pointing to another page of results
1 - 255"MzE1NjAwMDcxNzQ0ODI5"
1 <= x <= 1000Was this page helpful?