Skip to content
Proud to collaborate with Microsoft for Startups

roadmap.claim-next ​

Atomically claim the next ready roadmap node for an actor, bind the ticket assignee, and optionally start software-delivery.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
roadmap_uuidstringYes——
claimant_typestringYes——
claimant_uuidstringYes——
node_uuidstringNo——
allow_manager_overridebooleanNo——
assign_ticketbooleanNo——
dispatchbooleanNo——
start_deliverybooleanNo——
work_uuidstringNo——
idempotency_keystringNo——
policy_uuidstringNo——
actor_typestringNo——
actor_uuidstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
roadmap_uuidstringNo——
node_uuidstringNo——
ticket_uuidstringNo——
assignedbooleanNo——
dispatchedbooleanNo——
delivery_startedbooleanNo——
delivery_workflow_idstringNo——
nodedictNo——
organization_uuidstringNo—Input field preserved in workflow state.
claimant_typestringNo—Input field preserved in workflow state.
claimant_uuidstringNo—Input field preserved in workflow state.
allow_manager_overridebooleanNo—Input field preserved in workflow state.
assign_ticketbooleanNo—Input field preserved in workflow state.
dispatchbooleanNo—Input field preserved in workflow state.
start_deliverybooleanNo—Input field preserved in workflow state.
work_uuidstringNo—Input field preserved in workflow state.
idempotency_keystringNo—Input field preserved in workflow state.
policy_uuidstringNo—Input field preserved in workflow state.
actor_typestringNo—Input field preserved in workflow state.
actor_uuidstringNo—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": "roadmap.claim-next",
  "initial_data": {
    "organization_uuid": "value",
    "roadmap_uuid": "value",
    "claimant_type": "value",
    "claimant_uuid": "value"
  }
}