listProcesses | Process instances with status and completion %; optionally filtered by workflowDefinitionId, status, tag and query — search-attribute conditions such as customerId = "C-9" AND amount > 100 (then one page: page, size) |
createBatchOperation / listBatchOperations / getBatchOperation / cancelBatchOperation | Cancel, retry, restart, pause, resume, set variables or retry from a step for every process a filter matches, in the background; follow its progress, skip reasons and errors; cancel it (guide) |
migrateProcessesInBatch | A MIGRATE batch: move every live process of a definition (of one version, fromVersion) onto another version with one step mapping |
getProcessDetails | Full process detail: variables + all step executions |
findProcessByBusinessKey | Look up a process by its business key |
getProcessLogs | Audit trail and log messages for a process |
listInFlightProcesses | Processes in flight (PENDING, RUNNING, PAUSED) from the process-index read model — one indexed read; empty when workflow.projection.enabled is off |
countProcessesByStatus | Process counts by status across the fleet, from the process-index read model; empty when the projection is off |
retryProcess | Pick a stopped process up where it stopped: the failed (or cancelled) steps run again, the ones that succeeded are left alone. ERROR or CANCELLED only |
restartProcess | Run a stopped process again from the beginning, the steps that already succeeded included, with the variables it was created with. ERROR or CANCELLED only |
setProcessVariables | Change a live process’s variables (set, remove) — an audited admin operation; reason mandatory (guide) |
revealProcessVariable | The value of one sensitive variable (shown as •••• by every other tool) — needs a workflow.security.sensitive.reveal-roles role and a reason; audited (guide) |
completeStepManually | Complete a step execution by hand with output variables, as if its worker had answered; the flow carries on |
retryProcessFromStep | Run a live process again from one of its steps: it and everything downstream start over |
dryRunProcessMigration / migrateProcess | Plan, then carry out, moving a live process onto another version of its definition — a step mapping, variables, the reason (guide) |
listIncidents / getIncidentProcesses / retryIncident | Failures grouped by definition, step and error family; their processes; retry a whole group — as a RETRY batch operation, whose id it returns |
pauseProcess / resumeProcess | Pause a PENDING or RUNNING process (in-flight work finishes, successors held, clocks frozen) and resume it |
pauseWorkflow / resumeWorkflow | Pause/resume a whole definition: all its processes, with new instances born paused |
sendMessage | Send an external message to resume processes waiting on a WAIT_FOR_MESSAGE step |
updateProcess / updateWithStart / listProcessUpdates | Apply a declared update to a running process (by id or business key) and get its result or why not; the same, starting the process when the key has none; a process’s updates (guide) |
getWorkflowAnalytics | Per-definition analytics: counts by status, rates, throughput per day, avg/p95 durations, bottleneck step (guide) |
findBottleneck | Where processes get stuck: slowest step, steps with waiting instances, steps with failures |
importWorkflowDefinitionsFromGit | Pull and upsert workflow JSON files from Git |
listRunsOfBusinessKey | Every run that has had a business key, oldest first — a CONTINUE_AS_NEW chain (linked by continuedFrom/continuedAs) or the runs a businessKeyPolicy let reuse it |
listWorkflowDefinitions | The definitions (id, name, status, whether they accept new instances) — what a schedule can start |
listSchedules / getSchedule | Every schedule, optionally of one workflow: cron (and in words), zone, variables, source, whether it is editable, paused, next starts |
createSchedule / updateSchedule / deleteSchedule | Manage the schedules created through the engine (source UI/API). A schedule declared in a definition or a cron.yaml is owned by its file and refused here |
pauseSchedule / resumeSchedule | Pause or resume any schedule; the pause is kept by id and survives re-imports |
runScheduleNow | Start the schedule’s workflow once, now, with its variables |
createEventTrigger / updateEventTrigger / deleteEventTrigger / exportEventTriggerYaml | Create a trigger (source UI/API) that starts a workflow on a domain event, edit or delete one created that way, and get its events.yaml entry to promote it to git (guide) |
listEventTriggers | Every event trigger, optionally of one workflow — declared in the definition, in an events.yaml or created through the engine: destination and topic, type, filter, business key, variables, source, status (guide) |
pauseEventTrigger / resumeEventTrigger | Pause or resume a trigger; while paused, matching events start nothing and are not replayed |
listReceivedEvents | The latest received domain events and what each did: started a process, delivered a message, or the error |
publishInboundEvent | Inject a domain event on a destination (for tests and systems without Kafka); returns what it started and delivered |
exportScheduleYaml | The schedule’s cron.yaml entry, id included, to promote it to git (lifecycle) |