info

Return document summary info including word, character, paragraph, heading, table, image, comment, tracked-change, SDT-field, and list counts, plus outline and capabilities.

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

Summary

Return document summary info including word, character, paragraph, heading, table, image, comment, tracked-change, SDT-field, and list counts, plus outline and capabilities.

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

Expected result

Returns a DocumentInfo object with counts (words, characters, paragraphs, headings, tables, images, comments, trackedChanges, sdtFields, lists), document outline, capability flags, and revision.

Input fields

No fields.

Example request

{}

Output fields

Field	Type	Required	Description
capabilities	object	yes
capabilities.canComment	boolean	yes
capabilities.canFind	boolean	yes
capabilities.canGetNode	boolean	yes
capabilities.canReplace	boolean	yes
counts	object	yes
counts.characters	integer	yes
counts.comments	integer	yes
counts.headings	integer	yes
counts.images	integer	yes
counts.lists	integer	yes
counts.paragraphs	integer	yes
counts.sdtFields	integer	yes
counts.tables	integer	yes
counts.trackedChanges	integer	yes
counts.words	integer	yes
outline	object[]	yes
revision	string	yes

Example response

{
  "capabilities": {
    "canComment": true,
    "canFind": true,
    "canGetNode": true,
    "canReplace": true
  },
  "counts": {
    "characters": 1,
    "comments": 0,
    "headings": 3,
    "images": 2,
    "lists": 1,
    "paragraphs": 12,
    "sdtFields": 1,
    "tables": 1,
    "trackedChanges": 1,
    "words": 250
  },
  "outline": [
    {
      "level": 1,
      "nodeId": "node-def456",
      "text": "Hello, world."
    }
  ],
  "revision": "example"
}

Pre-apply throws

• None

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "capabilities": {
      "additionalProperties": false,
      "properties": {
        "canComment": {
          "type": "boolean"
        },
        "canFind": {
          "type": "boolean"
        },
        "canGetNode": {
          "type": "boolean"
        },
        "canReplace": {
          "type": "boolean"
        }
      },
      "required": [
        "canFind",
        "canGetNode",
        "canComment",
        "canReplace"
      ],
      "type": "object"
    },
    "counts": {
      "additionalProperties": false,
      "properties": {
        "characters": {
          "type": "integer"
        },
        "comments": {
          "type": "integer"
        },
        "headings": {
          "type": "integer"
        },
        "images": {
          "type": "integer"
        },
        "lists": {
          "type": "integer"
        },
        "paragraphs": {
          "type": "integer"
        },
        "sdtFields": {
          "type": "integer"
        },
        "tables": {
          "type": "integer"
        },
        "trackedChanges": {
          "type": "integer"
        },
        "words": {
          "type": "integer"
        }
      },
      "required": [
        "words",
        "characters",
        "paragraphs",
        "headings",
        "tables",
        "images",
        "comments",
        "trackedChanges",
        "sdtFields",
        "lists"
      ],
      "type": "object"
    },
    "outline": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "level": {
            "type": "integer"
          },
          "nodeId": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "level",
          "text",
          "nodeId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "revision": {
      "type": "string"
    }
  },
  "required": [
    "counts",
    "outline",
    "capabilities",
    "revision"
  ],
  "type": "object"
}