Document apiReferenceToc

toc.get

Retrieve details of a specific table of contents.

read-onlyidempotent
doc.toc.get(…)

Expected result

Returns a TocInfo object with the instruction, source/display configuration, and entry count.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"tableOfContents"required
nodeIdstringrequired

Result

Output fields
nodeType"tableOfContents"required
kind"block"required
propertiesobjectrequired
Fields
instructionstringrequired
sourceConfigobject
displayConfigobject
preservedSwitchesobject
entryCountintegerrequired

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