capabilityDocuments
Places module · 6 operations
List capability document rows
GET/capability-documents
A venue capability document with a validity window. A frozen document cannot change. Returns a cursor page of capability document rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a capability document
POST/capability-documents
A venue capability document with a validity window. A frozen document cannot change. Creates a capability document. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
Get a capability document
GET/capability-documents/{id}
A venue capability document with a validity window. A frozen document cannot change. Returns one capability document with its `ETag`. A capability document the caller may not see returns 404.
Update a capability document
PATCH/capability-documents/{id}
A venue capability document with a validity window. A frozen document cannot change. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
Delete a capability document
DELETE/capability-documents/{id}
A venue capability document with a validity window. A frozen document cannot change. Soft-deletes the capability document: it moves to Trash and can be restored for its table's retention period.
Freeze a capability document
POST/capability-documents/{id}/freeze
Freezes the document so its content and validity window can no longer change. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.