Redact annotation content

Overview

Redact annotation content. 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 redact annotation content.
• 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 POST \
  --url "$ORDINATE_URL/v1/annotations/00000000-0000-4000-8000-000000000001/redact" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "reason": "string",
    "scope": "body"
  }'

{
  "version": 0
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to redact annotation content. The documented 200 response is new redaction version.

How it works

Reference

Required capability

redact

Authorization scope

handler-resolved target

{
  "reason": "string",
  "scope": "body"
}

{
  "version": 0
}

{
  "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/redact`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "reason": "string",
  "scope": "body"
})
});

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

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