List deployed process definitions. Filter by key, name, version, category, or tenant. Returns key, id, version, and deployment info for each definition.

Count deployed process definitions matching filter criteria. Supports same filters as list. Use before listing to plan pagination.

Retrieve a single process definition by its unique ID. Returns full metadata: key, version, deployment ID, resource name, and tenant.

Retrieve the latest deployed version of a process definition by its key. Returns full metadata including version, deployment ID, and start form key.

Delete a process definition by ID. Set cascade=true to also delete running instances, history, and jobs. Fails if instances exist and cascade is false.

Delete all versions of a process definition by key. Set cascade=true to remove all instances and history. Fails if active instances exist and cascade is false.

Start a new process instance by process definition ID. Use when a specific definition version is required. Returns instance ID, state, and definition info.

Start a new process instance by definition key (latest version). Accepts optional business key and typed variables. Returns instance ID, state, and definition info.

Retrieve the BPMN 2.0 XML source of a process definition by ID. Useful for inspecting or debugging process models.

Retrieve the BPMN 2.0 XML source of the latest deployed version of a process definition by key.

Get activity-level statistics for a process definition: instance counts per activity, failed job counts, and incident counts. Useful for bottleneck analysis.

Get process definition statistics across all deployed definitions: instance counts, failed job counts, and incident counts per definition.

Suspend or activate a process definition by key. Suspended definitions cannot be started. Set includeProcessInstances=true to also suspend all running instances.

Update the history time-to-live (in days) for a specific process definition version by ID. Controls how long historic instances are retained.

Update the history time-to-live (in days) for all versions of a process definition by key. Controls historic data retention.

Restart one or more process instances for a process definition. Use to re-execute failed or completed instances from a given activity.

List all process definitions statically called (via call activity) by a given process definition ID. Useful for dependency analysis.

List deployments in the engine. Filter by name, source, deployment time range, or tenant. Returns deployment ID, name, and time for each deployment.

Count deployments matching filter criteria. Supports same filters as deployment list.

Delete a deployment by ID. Set cascade=true to also delete running instances and history. Use skipCustomListeners and skipIoMappings to bypass lifecycle hooks.

Retrieve a deployment by its ID. Returns deployment name, source, time, and tenant ID.

List all resources (BPMN files, DMN files, forms) included in a deployment by deployment ID.

Redeploy an existing deployment, optionally selecting specific resources. Creates a new deployment from resources of a previous deployment.

Restart process instances asynchronously (returns a batch job). Use when restarting many instances to avoid timeout.

Claim a user task for the specified user. After claiming, the task is assigned to that user and removed from candidate group queues.

Unclaim a user task, removing the current assignee. The task returns to the candidate group queue and can be claimed by another user.

Complete a user task, advancing the process to the next step. Optionally provide output variables to pass to the process. Returns confirmation.

Delegate a user task to another user. The original owner retains ownership but the delegated user can complete it. Use for escalation workflows.

Directly assign a user task to a specific user without going through the claim workflow. Overwrites any existing assignee.

Create a standalone user task not attached to a process instance. Useful for ad-hoc work items. Provide name, assignee, priority, and due date.

Update metadata of a user task: name, description, assignee, due date, priority, or parent task. Does not advance the task in the workflow.

Retrieve all variables associated with a user task. Returns variables from task scope and parent process scope.

Add or update multiple variables on a user task. Variables set here are available in the process after task completion. Provide typed variable values.

Resolve a delegated task, returning ownership to the original owner. Use after the delegate has completed their work to restore normal ownership.

Throw a BPMN error from a user task, triggering the boundary error event on the process. Use to signal an exceptional condition during task execution.

Query user tasks with rich filtering: by assignee, candidate group, process instance, variables, due date, and more. Returns task metadata for operator review.

Retrieve a single user task by its ID. Returns task name, assignee, due date, priority, and process instance.

Count user tasks matching filter criteria. Supports same filters as task list. Useful for workload sizing.

List active incidents in the engine. Filter by type, message, process definition, or activity. Incidents indicate failed jobs, failed scripts, or custom conditions.

Retrieve a single incident by ID. Returns type, message, cause, root cause, process definition ID, and activity ID.

Count active incidents matching filter criteria. Use to gauge operational health before investigating individual incidents.

Resolve an incident by ID, clearing the error state and allowing the process to continue or be retried. Only applicable to custom incident types.

List jobs with optional filters: process instance, job definition, exception presence, retries, and due date range. Returns id, type, retries, dueDate, and exceptionMessage.

Count jobs matching filter criteria. Use to assess backlog size before listing.

Retrieve a single job by ID. Returns id, type, retries, dueDate, exceptionMessage, and process instance details.

Trigger immediate execution of a specific job. Use to manually run a scheduled or async job without waiting for its due date.

Suspend or resume a specific job by ID. Suspended jobs will not be executed by the job executor. Resume to re-enable execution.

Set the retry count for a failed job. Use to reset retries after fixing the root cause of a job failure. Set to 1 or more to re-enable execution.

Retrieve the exception stacktrace for a failed job. Use to diagnose the root cause of job failures.

List job definitions with filters. Returns timer and async service task definitions with their current suspension state and override priority.

Retrieve a single job definition by ID. Returns activity details, process definition, and suspension state.

Suspend or resume all jobs for a job definition. Use includeJobs=true to also suspend/resume active job instances for this definition.

Create a new Operaton user account with profile (id, firstName, lastName, email) and credentials (password). Returns confirmation on success.

Query Operaton users by id, firstName, lastName, email, or group membership. Returns profile info for each matching account.

Retrieve the profile of a specific Operaton user by ID. Returns firstName, lastName, and email.

Update the profile of an existing Operaton user: firstName, lastName, or email. Returns confirmation on success.

Update the password for an existing Operaton user. Requires the current password for non-admin users. Returns confirmation on success.

Delete an Operaton user account by ID. Returns confirmation on success. Returns a not-found error if the user does not exist.

Unlock a locked Operaton user account. Use when a user has been locked due to failed login attempts.

Create a new Operaton group with an id, name, and optional type. Groups are used to manage candidate task assignments and authorization.

Query Operaton groups by id, name, type, or member user ID. Returns group details for each matching group.

Delete an Operaton group by ID. Returns confirmation on success. Returns a not-found error if the group does not exist.

Add a user to an Operaton group by user ID and group ID. The user will receive task assignments for this group's candidate tasks.

Remove a user from an Operaton group. The user will no longer receive task assignments for this group's candidate tasks.

Query historic process instances by key, business key, state (active/completed), or date range. Returns id, definitionKey, startTime, endTime, duration, and state.

Query historic activity instances for a process instance. Returns activityId, name, type, startTime, endTime, duration, and assignee for user tasks.

Query historic task instances by process instance, definition key, assignee, or completion state. Returns name, assignee, endTime, duration, and process instance ID.

Query historic variable instances by process instance ID or variable name. Returns variable name, type, value, and the activity instance that set it.

Query historic incidents including resolved ones. Filter by process instance, type, or resolution state. Use for post-incident analysis.

Query historic job execution logs for a process instance. Returns log entries with timestamp, job type, retries, and exception details.

Query the user operation audit log. Returns who performed what operation (claim, complete, delete) on which entity and when.

List deployed DMN decision definitions. Filter by key, name, version, or tenant. Returns decision key, id, version, and deployment info.

Retrieve the latest deployed version of a decision definition by its key. Returns key, id, version, and deployment details.

Retrieve the DMN XML of the latest version of a decision definition by key. Use to inspect the current decision table logic.

Evaluate a deployed DMN decision table by key with typed input variables. Returns the matched rule outputs. Used to test decision logic through AI.

List deployed Decision Requirements Definitions (DRDs). DRDs describe dependencies between decision tables in a complex DMN model.

List active process instances with optional filters: business key, definition key/id, state, variable values, and tenant. Returns id, definitionKey, state, and business key.

Count active process instances matching filter criteria. Supports same filters as list. Use before listing to plan pagination.

Retrieve a single active process instance by ID. Returns id, definitionKey, businessKey, state, startTime, and tenant.

Delete (cancel) an active process instance by ID. Accepts an optional deletion reason that is recorded in history. Returns confirmation on success.

Suspend or resume a process instance by ID. Set suspended=true to pause execution, suspended=false to resume. Suspended instances cannot advance until resumed.

Retrieve all variables for an active process instance. Returns each variable with its name, type, and value. Use to inspect current execution state.

Add or update multiple variables on an active process instance in a single call. Provide a map of variable names to typed values. Existing variables are overwritten.

Retrieve a single named variable from an active process instance. Returns the variable value, type, and scope.

Set a single named variable on an active process instance. Provide the variable name, value, and type. Overwrites any existing value for that variable.

Retrieve the activity instance tree for a process instance. Shows current active activities, called sub-processes, and execution structure.

Deploy a BPMN or DMN artifact to Operaton. Provide the XML content, filename (.bpmn or .dmn), and a deployment name. Returns deployment ID and deployed definition keys.

Deploy a BPMN process definition to Operaton. Provide BPMN or DMN XML, a filename, and a deployment name. Returns deployment metadata and deployed definition keys.

Deploy a DMN decision artifact to Operaton. Provide DMN XML, a .dmn filename, and a deployment name. Returns deployment metadata and deployed decision definition keys.

List active process instances eligible for migration. Returns per-instance eligibility with call-activity blocking conditions. Filters: definition key, source version, business key pattern.

Compare source and target process definition activities. Returns auto-mappable pairs, unmapped source activities, new target activities. Optionally checks required variable presence on supplied instance IDs.

Generate a migration plan from a source to target process definition. Returns auto-mapped activity instructions and a list of unmapped source activities requiring explicit mapping.

Validate a migration plan against a set of process instances. Returns typed errors, sampled-validation flag, and consequence disclosure (timers, external tasks, cancellations).

Execute a migration plan asynchronously. Auto-chunks large instance lists. Returns batch IDs and chunk submission errors. Supports dryRun mode (validates without creating batches).

Suspend one or more migration batches by ID. Returns per-batch success or error.

Resume one or more suspended migration batches by ID. Returns per-batch success or error.

Cancel (delete) one or more migration batches by ID. Returns per-batch success or error.

List active migration batches (type MIGRATE_PROCESS_INSTANCE). Optionally filter by suspended state.

Poll migration batch(es) until all complete or timeout is reached. Returns COMPLETED or TIMEOUT with aggregated progress (completed, failed, pending job counts).

Get current status of a single migration batch: totalJobs, jobsCreated, jobsCompleted, jobsFailed, suspended.