approvalInstances
Platform module · 4 operations
List approval instance rows
GET/approval-instances
An approval in flight for one subject. Returns a cursor page of approval instance rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create an approval instance
POST/approval-instances
An approval in flight for one subject. Creates an approval instance. 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 an approval instance
GET/approval-instances/{id}
An approval in flight for one subject. Returns one approval instance with its `ETag`. A approval instance the caller may not see returns 404.
Withdraw an approval
POST/approval-instances/{id}/cancel
Withdraws an approval in review, or an Approved one the document has not used (app.cancel_approval): the requester, when approvals.requester_may_cancel allows it (approval_requester_cancel_off: 422), or a holder of org.approval_policies.write. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.