Groups

Inspect a unit of work and what remains to undo

get/v1/groups/{groupKey}

Request

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

Path parameters

groupKeystring required

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