Document apiReferenceToc

toc.getEntry

Retrieve details of a specific TC (table of contents entry) field.

read-onlyidempotent
doc.toc.getEntry(…)

Expected result

Returns a TocEntryInfo object with the instruction, text, level, and switch configuration.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"tableOfContentsEntry"required
nodeIdstringrequired

Result

Output fields
nodeType"tableOfContentsEntry"required
kind"inline"required
propertiesobjectrequired
Fields
instructionstringrequired
textstringrequired
levelintegerrequired
tableIdentifierstring
omitPageNumberbooleanrequired

Failures

Pre-apply throws

  • TARGET_NOT_FOUND

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