Document apiReferenceDocument index

index.entries.get

Get detailed information about a specific XE index entry.

read-onlyidempotent
doc.index.entries.get(…)

Expected result

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

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"indexEntry"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired

Result

Output fields

No fields.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas