Skip to main content

​
Summary

Get detailed information about a specific permission range by ID.
  • Operation ID: permissionRanges.get
  • API member path: editor.doc.permissionRanges.get(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns a PermissionRangeInfo object with the range principal, kind, and positions.

​
Input fields

FieldTypeRequiredDescription
idstringyes

​
Example request

{
  "id": "id-001"
}

​
Output fields

No fields.

​
Example response

{}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

{
  "type": "object"
}