Workflow Management

📄️ Delete Workflow

Remove workflow execution permanently from the system.

📄️ Get Workflows by Correlation ID

With the list of correlation IDs, this API helps in finding and returning workflows.

📄️ Pause Workflow

This API pauses the execution of a running workflow. Any currently running tasks will finish, but no new tasks will be scheduled until the workflow is resumed.

📄️ Rerun Workflow

Reruns a workflow from a specific task (ReRunFromTaskId) and optionally change the input. If required, it also updates the completed tasks with new input (ReRunFromTaskId).

Restart a workflow execution from the beginning with the same input. This operation has no effect when called on a workflow that is not in a terminal status. If useLatestDefinition is set, the restarted workflow fetches the latest definition from the metadata store.

📄️ Resume Workflow

Resume the execution of a workflow that is paused. If the workflow is not paused, this method has no effect.

📄️ Retry Failed Workflow

This API retries a failed workflow from the last failed task.

📄️ Search Workflow Executions

Used to retrieve a list of workflow executions based on the provided search criteria.

📄️ Skip Task from Workflow Execution

Skips a given task execution from a currently running workflow.

📄️ Start Workflow Execution

Starts a workflow and returns the ID of the workflow. The API returns immediately without waiting for the workflow to be completed.

📄️ Synchronous Execution

Starts a workflow and waits until the workflow completes or the waitUntilTask completes.

📄️ Terminate Workflow

Terminates a running workflow. A reason must be provided that is captured as the termination reason for the workflow.

📄️ Upgrade Workflow

Upgrade Workflow API upgrades a running workflow to a newer/older version. When the workflow is running, one of the tasks would be currently in the execution state. When this workflow is upgraded using this API, all the tasks in the newer definition before this running task will be marked as skipped.

📄️ Rate Limit Workflow

The workflow rate limit limits the number of workflow executions at any given time. Workflow triggered after exceeding the rate limit will get queued based on the trigger time.

📄️ Update Variable

Update the workflow variables at any time while the workflow is in the RUNNING state. This is similar to the SET_VARIABLE task, except it can be updated anytime while the workflow is running.