clearContent

Summary

Clear all document body content, leaving a single empty paragraph.

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

Expected result

Returns a Receipt with success status; reports NO_OP if the document is already empty.

Input fields

No fields.

Example request

{}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
`affectedStories`	StoryLocator[]	no
`id`	string	no
`inserted`	EntityAddress[]	no
`invalidatedRefs`	AffectedRef[]	no
`remappedRefs`	AffectedRefRemapping[]	no
`removed`	EntityAddress[]	no
`success`	`true`	yes	Constant: `true`
`textRangeShifts`	TextRangeShift[]	no
`txId`	string	no
`updated`	EntityAddress[]	no

Variant 2 (success=false)

Field	Type	Required	Description
`failure`	object	yes
`failure.code`	enum	yes	`"NO_OP"`
`failure.details`	any	no
`failure.message`	string	yes
`success`	`false`	yes	Constant: `false`

Example response

{
  "id": "id-001",
  "inserted": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ],
  "success": true
}

Pre-apply throws

CAPABILITY_UNAVAILABLE

Non-applied failure codes

NO_OP

Raw schemas

Raw input schema

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

Raw output schema

{
  "oneOf": [
    {
      "$ref": "#/$defs/ReceiptSuccess"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "$ref": "#/$defs/ReceiptSuccess"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

Summary

Expected result

Input fields

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Variant 1 (success=true)

​Variant 2 (success=false)

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas