Document apiReferenceFootnotes

footnotes.configure

Configure numbering and placement for footnotes or endnotes.

mutates documentdry runidempotent
doc.footnotes.configure(…)

Expected result

Returns a FootnoteConfigResult indicating success or a failure.

Inputs

type"footnote" | "endnote"required
scopedocument | sectionrequired
document
kind"document"required
section
kind"section"required
sectionIdstringrequired
1 additional input field
numberingobject
Fields
format"decimal" | "lowerRoman" | "upperRoman" | "lowerLetter" | "upperLetter" | "symbol"
startinteger
restartPolicy"continuous" | "eachSection" | "eachPage"
position"pageBottom" | "beneathText" | "sectionEnd" | "documentEnd"

Result

Output fields
true
successtruerequired
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