Document apiReferenceDocument index

index.entries.update

Update the properties of an existing XE index entry.

mutates documentdry runidempotent
doc.index.entries.update(…)

Expected result

Returns an IndexEntryMutationResult indicating success or a failure.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"indexEntry"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
patchobjectrequired
Fields
textstring
subEntrystring
boldboolean
italicboolean
crossReferencestring
pageRangeBookmarkstring
entryTypestring
yomistring

Result

Output fields
true
successtruerequired
entryobjectrequired
Fields
kind"inline"required
nodeType"indexEntry"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • 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