Module bpmn_instance_api 

Enums

CancelBpmnInstanceError

struct for typed errors of method cancel_bpmn_instance

GetBpmnInstanceError

struct for typed errors of method get_bpmn_instance

GetBpmnInstanceStatusError

struct for typed errors of method get_bpmn_instance_status

ListBpmnIncidentsError

struct for typed errors of method list_bpmn_incidents

ListBpmnInstancesError

struct for typed errors of method list_bpmn_instances

PreviewBpmnInstanceError

struct for typed errors of method preview_bpmn_instance

RetryBpmnIncidentError

struct for typed errors of method retry_bpmn_incident

StartBpmnInstanceError

struct for typed errors of method start_bpmn_instance

Functions

cancel_bpmn_instance

get_bpmn_instance

get_bpmn_instance_status

Frontend-facing projection of the process instance’s live runtime state (lifecycle, per-activity status, variables, history, incidents), consumed by the live process token overlay. 404 if the instance isn’t in the workspace, or if the engine has not picked it up yet (no runtime state).

list_bpmn_incidents

list_bpmn_instances

preview_bpmn_instance

Start a process instance from an undeployed diagram (#710 stage 3), the "run without deploying" counterpart to POST /bpmn/run/p/{path}. The submitted XML is parsed and validated exactly as a real deploy would – nothing is written to bpmn_flow/bpmn_flow_version.

retry_bpmn_incident

Validates the ActivityFailed incident, identified by the original failed child job’s id, and records a retry intent on the process instance. The execution engine does not yet act on this intent: retrying an incident is not yet functional end-to-end. This endpoint only validates ownership of the incident and records the intent for a future engine version to consume.

start_bpmn_instance