footnotes.get

Summary

Get detailed information about a specific footnote or endnote.

Operation ID: footnotes.get
API member path: editor.doc.footnotes.get(...)
Mutates document: no
Idempotency: idempotent
Supports tracked mode: no
Supports dry run: no
Deterministic target resolution: yes

Expected result

Returns a FootnoteInfo object with the note’s type, display number, and content.

Input fields

Field	Type	Required	Description
`target`	object(kind=“entity”)	yes
`target.entityType`	`"footnote"`	yes	Constant: `"footnote"`
`target.kind`	`"entity"`	yes	Constant: `"entity"`
`target.noteId`	string	yes

Example request

{
  "target": {
    "entityType": "footnote",
    "kind": "entity",
    "noteId": "example"
  }
}

Output fields

No fields.

Example response

{}

Pre-apply throws

TARGET_NOT_FOUND
CAPABILITY_UNAVAILABLE

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "additionalProperties": false,
      "properties": {
        "entityType": {
          "const": "footnote"
        },
        "kind": {
          "const": "entity"
        },
        "noteId": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "entityType",
        "noteId"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Raw output schema

{
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas