tables.get

Retrieve table structure and dimensions by locator.

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

Summary

Retrieve table structure and dimensions by locator.

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

Expected result

Returns a TablesGetOutput with the table row count, column count, and structural metadata.

Input fields

Variant 1

No fields.

Variant 2

No fields.

Example request

{
  "nodeId": "node-def456",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  }
}

Output fields

Field	Type	Required	Description
address	BlockNodeAddress	yes	BlockNodeAddress
address.kind	"block"	yes	Constant: "block"
address.nodeId	string	yes
address.nodeType	enum	yes	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"
columns	integer	yes
nodeId	string	yes
rows	integer	yes

Example response

{
  "address": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  },
  "columns": 1,
  "nodeId": "node-def456",
  "rows": 1
}

Pre-apply throws

• TARGET_NOT_FOUND

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target"
      ]
    },
    {
      "required": [
        "nodeId"
      ]
    }
  ],
  "properties": {
    "nodeId": {
      "type": "string"
    },
    "target": {
      "$ref": "#/$defs/BlockNodeAddress"
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/BlockNodeAddress"
    },
    "columns": {
      "minimum": 0,
      "type": "integer"
    },
    "nodeId": {
      "type": "string"
    },
    "rows": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "nodeId",
    "address",
    "rows",
    "columns"
  ],
  "type": "object"
}