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

​
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

FieldTypeRequiredDescription
optionsobjectno
options.includeContextbooleanno
options.includeProvenancebooleanno
options.includeResolvedbooleanno

​
Example request

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

​
Output fields

FieldTypeRequiredDescription
bodyarrayyes
modelVersion"sdm/1"yesConstant: "sdm/1"

​
Example response

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

​
Pre-apply throws

  • None

​
Non-applied failure codes

  • None

​
Raw schemas

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

{
  "additionalProperties": false,
  "properties": {
    "body": {
      "type": "array"
    },
    "modelVersion": {
      "const": "sdm/1"
    }
  },
  "required": [
    "modelVersion",
    "body"
  ],
  "type": "object"
}