Document apiReferenceToc

toc.listEntries

List all TC (table of contents entry) fields in the document body.

read-onlyidempotent
doc.toc.listEntries(…)

Expected result

Returns a TocListEntriesResult with an array of TC entry discovery items and pagination metadata.

Inputs

tableIdentifierstring
levelRangeobject
Fields
fromintegerrequired
tointegerrequired
limitinteger
offsetinteger

Result

Output fields
evaluatedRevisionstringrequired
totalintegerrequired
itemsobject[]required
pagePageInforequired
Fields
limitintegerrequired
offsetintegerrequired
returnedintegerrequired

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