Groups

Roll back a unit of work and get the compensation plan

Marks the group as unwinding — it will refuse new forward steps — and returns the exact compensations to perform, in reverse completion order. Ratchet does not perform them: gate each one with begin (using its suggested idempotency key, so the undo is itself at-most-once), do the work, then report it.

post/v1/groups/{groupKey}/unwind

Request

  • Base URL: https://ratchetgate.com
  • URL: https://ratchetgate.com/v1/groups/{groupKey}/unwind
  • Auth: HTTP bearer

Path parameters

groupKeystring required

Request body

reasonstring

Response

Default Response

group_idstring
group_keystring
state'open' | 'committed' | 'unwinding' | 'unwound' | 'unwind_failed'
reasonstring nullable
stepsobject[]

Compensations to perform, in the order given — reverse of completion order.

irreversibleobject[]

Effects that succeeded but declared no compensation. These cannot be rolled back automatically.

unresolvedobject[]

Effects whose real-world outcome is unknown. Resolve these BEFORE rolling back around them.

next_stepstring

Changes

No recorded changes to this operation across all 1 revision of this API.