Get an annotation - Cognite Docs

GET

annotations

{annotationId}

JavaScript SDK

const annotationIds = [{ id: 1 }, { id: 2 }];

const response = await client.annotations.retrieve(annotationIds);

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
    }
  },
  "status": "approved"
}

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

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.

Scopes

https://{cluster}.cognitedata.com/.default

oidc-token

https://{cluster}.cognitedata.com/.default

oauth2-client-credentials

https://api.cognitedata.com/.default

oauth2-open-industrial-data

https://{cluster}.cognitedata.com/.default

oauth2-auth-code

Path Parameters

annotationId

integer<int64>

required

The internal ID of the annotation Server-generated identifier for the annotation

Required range: 1 <= x <= 9007199254740991

Example:

4096

Response

Successful retrieval

integer<int64>

required

Server-generated identifier for the annotation

Required range: 1 <= x <= 9007199254740991

Example:

4096

createdTime

integer<int64>

required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

lastUpdatedTime

integer<int64>

required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

annotatedResourceType

enum<string>

required

The annotated CDF resource type. Files as well as 3d-Models are supported.

Available options:

file,

threedmodel

Example:

"file"

annotatedResourceId

integer<int64>

required

The internal ID of the annotated resource.

Required range: 1 <= x <= 9007199254740991

Example:

1337

annotationType

enum<string>

required

The type of the annotation. This uniquely decides what the structure of the data block will be.

Available options:

pointcloud.BoundingVolume,

images.Classification,

forms.Detection,

documents.ExtractedText,

diagrams.FileLink,

isoplan.IsoPlanAnnotation,

diagrams.Junction,

images.KeypointCollection,

diagrams.Line,

images.ObjectDetection,

images.TextRegion,

diagrams.UnhandledSymbolObject,

diagrams.UnhandledTextObject,

diagrams.AssetLink,

diagrams.InstanceLink,

images.AssetLink,

images.InstanceLink

Example:

"pointcloud.BoundingVolume"

creatingApp

string

required

The application name or identifier. This is neither checked nor enforced.

Required string length: 1 - 255

Example:

"cognite-vision"

creatingAppVersion

string

required

A version number in the SemVer sense. See semver.org for the specification.

Required string length: 1 - 255

Example:

"1.2.1"

creatingUser

string | null

required

A username, or email, or name. This is not checked nor enforced. If the value is null, it means the annotation was created by a service.

Required string length: 1 - 255

Example:

"john.doe@cognite.com"

data

pointcloud.BoundingVolume · object

required

The annotation information. The format of this object is decided by and validated against the annotationType attribute.

Show child attributes

Example:

{ "assetRef": { "externalId": "abc" } }

status

enum<string>

required

The status of the annotation

Available options:

suggested,

approved,

rejected

Example:

"approved"

⌘I

JavaScript SDK

const annotationIds = [{ id: 1 }, { id: 2 }];

const response = await client.annotations.retrieve(annotationIds);

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/{annotationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
    }
  },
  "status": "approved"
}

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}