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

​
Summary

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

​
Expected result

Returns an IndexEntryInfo object with the entry’s text, sub-entry, formatting, and instruction.

​
Input fields

FieldTypeRequiredDescription
targetobject(kind=“inline”)yes
target.anchorInlineAnchoryesInlineAnchor
target.anchor.endPositionyesPosition
target.anchor.end.blockIdstringyes
target.anchor.end.offsetintegeryes
target.anchor.startPositionyesPosition
target.anchor.start.blockIdstringyes
target.anchor.start.offsetintegeryes
target.kind"inline"yesConstant: "inline"
target.nodeType"indexEntry"yesConstant: "indexEntry"

​
Example request

{
  "target": {
    "anchor": {
      "end": {
        "blockId": "block-abc123",
        "offset": 0
      },
      "start": {
        "blockId": "block-abc123",
        "offset": 0
      }
    },
    "kind": "inline",
    "nodeType": "indexEntry"
  }
}

​
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": {
        "anchor": {
          "$ref": "#/$defs/InlineAnchor"
        },
        "kind": {
          "const": "inline"
        },
        "nodeType": {
          "const": "indexEntry"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "anchor"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

{
  "type": "object"
}