List annotation versions

Overview

List annotation versions. Annotations attach human context and evidence to operational data without changing the recorded series values.

When to use it

• Use it when an application needs to list annotation versions.
• Use it when an operator needs to add, find, revise, or preserve context around an event or time range.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/annotations/00000000-0000-4000-8000-000000000001/versions" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "versions": [
    {}
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to list annotation versions. The documented 200 response is version history including redaction reasons.

How it works

Reference

Required capability

read

Authorization scope

handler-resolved target

{
  "versions": [
    {}
  ]
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/annotations/00000000-0000-4000-8000-000000000001/versions`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);