Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Configure numbering and placement for footnotes or endnotes.
  • Operation ID: footnotes.configure
  • API member path: editor.doc.footnotes.configure(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns a FootnoteConfigResult indicating success or a failure.

​
Input fields

FieldTypeRequiredDescription
numberingobjectno
numbering.formatenumno"decimal", "lowerRoman", "upperRoman", "lowerLetter", "upperLetter", "symbol"
numbering.positionenumno"pageBottom", "beneathText", "sectionEnd", "documentEnd"
numbering.restartPolicyenumno"continuous", "eachSection", "eachPage"
numbering.startintegerno
scopeobject(kind=“document”) \object(kind=“section”)yesOne of: object(kind=“document”), object(kind=“section”)
typeenumyes"footnote", "endnote"

​
Example request

{
  "numbering": {
    "format": "decimal",
    "start": 0
  },
  "scope": {
    "kind": "document"
  },
  "type": "footnote"
}

​
Output fields

​
Variant 1 (success=true)

FieldTypeRequiredDescription
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codestringyes
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

{
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "numbering": {
      "additionalProperties": false,
      "properties": {
        "format": {
          "enum": [
            "decimal",
            "lowerRoman",
            "upperRoman",
            "lowerLetter",
            "upperLetter",
            "symbol"
          ]
        },
        "position": {
          "enum": [
            "pageBottom",
            "beneathText",
            "sectionEnd",
            "documentEnd"
          ]
        },
        "restartPolicy": {
          "enum": [
            "continuous",
            "eachSection",
            "eachPage"
          ]
        },
        "start": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "scope": {
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "document"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "section"
            },
            "sectionId": {
              "type": "string"
            }
          },
          "required": [
            "kind",
            "sectionId"
          ],
          "type": "object"
        }
      ]
    },
    "type": {
      "enum": [
        "footnote",
        "endnote"
      ]
    }
  },
  "required": [
    "type",
    "scope"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "const": true
        }
      },
      "required": [
        "success"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "const": true
    }
  },
  "required": [
    "success"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}