Skip to content
Proud to collaborate with Microsoft for Startups

ticket.software-delivery.cost-reservation-release ​

Release one active delivery-cost reservation without recording spend.

Release unused budget using an idempotent settlement command.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
reservation_uuidstringYes——
idempotency_keystringYes——
reasonstringYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
reservationdictNo——
cost_summarydictNo——
changedbooleanNo——
organization_uuidstringNo—Input field preserved in workflow state.
reservation_uuidstringNo—Input field preserved in workflow state.
idempotency_keystringNo—Input field preserved in workflow state.
reasonstringNo—Input field preserved in workflow state.
failed_atstringNo—ISO-8601 timestamp when action_fail recorded the failure
failure_reasonstringNo—Human-readable failure reason from action_fail
failure_typestringNo—Engine-stamped failure category
failed_actionstringNo—Engine-stamped action that raised
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerstringNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—executeAccepted
executingNoNo—completeApplying the mutation
completedNoYesYes—Done
failedNoYesNo—Failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedexecuteexecutingRun the mutation
executingcompletecompletedFinalize
* (any state)failfailedCatch-all failure

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "ticket.software-delivery.cost-reservation-release",
  "initial_data": {
    "organization_uuid": "value",
    "reservation_uuid": "value",
    "idempotency_key": "value",
    "reason": "value"
  }
}