contentControls.listInRange

Summary

List content controls within a block range.

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

Expected result

Returns a ContentControlsListResult scoped to the range.

Input fields

Field	Type	Required
`endBlockId`	string	yes
`limit`	integer	no
`offset`	integer	no
`startBlockId`	string	yes

Example request

{
  "endBlockId": "example",
  "limit": 50,
  "offset": 0,
  "startBlockId": "example"
}

Output fields

Field	Type	Required	Description
`items`	object[]	yes
`total`	integer	yes

Example response

{
  "items": [
    {}
  ],
  "total": 1
}

Pre-apply throws

TARGET_NOT_FOUND
INVALID_INPUT
CAPABILITY_UNAVAILABLE

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "endBlockId": {
      "type": "string"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "startBlockId": {
      "type": "string"
    }
  },
  "required": [
    "startBlockId",
    "endBlockId"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "total": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total"
  ],
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

contentControls.listInRange

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