get

Summary

Read the full document as an SDDocument structure.

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

Expected result

Returns an SDDocument with body content projected into SDM/1 canonical shapes.

Input fields

Field	Type	Required
`options`	object	no
`options.includeContext`	boolean	no
`options.includeProvenance`	boolean	no
`options.includeResolved`	boolean	no

Example request

{
  "options": {
    "includeProvenance": true,
    "includeResolved": true
  }
}

Output fields

Field	Type	Required	Description
`body`	array	yes
`modelVersion`	`"sdm/1"`	yes	Constant: `"sdm/1"`

Example response

{
  "body": [],
  "modelVersion": "sdm/1"
}

Pre-apply throws

None

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "options": {
      "additionalProperties": false,
      "properties": {
        "includeContext": {
          "type": "boolean"
        },
        "includeProvenance": {
          "type": "boolean"
        },
        "includeResolved": {
          "type": "boolean"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "body": {
      "type": "array"
    },
    "modelVersion": {
      "const": "sdm/1"
    }
  },
  "required": [
    "modelVersion",
    "body"
  ],
  "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