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

​
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

FieldTypeRequiredDescription
endBlockIdstringyes
limitintegerno
offsetintegerno
startBlockIdstringyes

​
Example request

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

​
Output fields

FieldTypeRequiredDescription
itemsobject[]yes
totalintegeryes

​
Example response

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

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

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

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