Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Get detailed information about a specific index block.
  • Operation ID: index.get
  • API member path: editor.doc.index.get(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns an IndexInfo object with the index’s instruction, configuration, and entry count.

​
Input fields

FieldTypeRequiredDescription
targetobject(kind=“block”)yes
target.kind"block"yesConstant: "block"
target.nodeIdstringyes
target.nodeType"index"yesConstant: "index"

​
Example request

{
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "index"
  }
}

​
Output fields

No fields.

​
Example response

{}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "const": "block"
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "index"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

{
  "type": "object"
}