metadata.get

Get a single anchored-metadata entry by id, including its JSON payload.

Summary

Get a single anchored-metadata entry by id, including its JSON payload.

• Operation ID: metadata.get
• API member path: editor.doc.metadata.get(...)
• Mutates document: no
• Idempotency: idempotent
• Supports tracked mode: no
• Supports dry run: no
• Deterministic target resolution: yes

Expected result

Returns an AnchoredMetadataInfo with id, namespace, partName, and payload; or null if not found.

Input fields

Field	Type	Required	Description
id	string	yes

Example request

{
  "id": "id-001"
}

Output fields

Variant 1

No fields.

Variant 2

No fields.

Example response

{}

Pre-apply throws

• TARGET_NOT_FOUND
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "type": "object"
    },
    {
      "type": "null"
    }
  ]
}