getNodeById

Retrieve a single node by its unique ID.

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

Summary

Retrieve a single node by its unique ID.

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

Expected result

Returns an SDNodeResult envelope with the projected SDM/1 node and canonical address.

Input fields

Field	Type	Required	Description
nodeId	string	yes
nodeType	enum	no	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Example request

{
  "nodeId": "node-def456",
  "nodeType": "paragraph"
}

Output fields

Field	Type	Required	Description
address	NodeAddress	yes	NodeAddress
context	object	no
node	object	yes

Example response

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

Pre-apply throws

• TARGET_NOT_FOUND

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "nodeId": {
      "type": "string"
    },
    "nodeType": {
      "enum": [
        "paragraph",
        "heading",
        "listItem",
        "table",
        "tableRow",
        "tableCell",
        "tableOfContents",
        "image",
        "sdt"
      ]
    }
  },
  "required": [
    "nodeId"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/NodeAddress"
    },
    "context": {
      "type": "object"
    },
    "node": {
      "type": "object"
    }
  },
  "required": [
    "node",
    "address"
  ],
  "type": "object"
}