Document apiReferenceToc

toc.editEntry

Update the properties of a TC (table of contents entry) field.

mutates documentdry runconditional
doc.toc.editEntry(…)

Expected result

Returns a TocEntryMutationResult with the updated entry address on success, or NO_OP if no change.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"tableOfContentsEntry"required
nodeIdstringrequired
patchobjectrequired
Fields
textstring
levelinteger
tableIdentifierstring
omitPageNumberboolean

Result

Output fields
true
successtruerequired
entryobjectrequired
Fields
kind"inline"required
nodeType"tableOfContentsEntry"required
nodeIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE" | "INVALID_INSERTION_CONTEXT" | "INVALID_INPUT"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • NO_OP

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