Skip Task in Workflow Execution

Endpoint: PUT /api/workflow/{workflowId}/skiptask/{taskReferenceName}

Skips a pending task in an ongoing workflow using the task reference name. The skipped task’s inputs and outputs can be updated using the query parameters.

Path parameters

Parameter	Description	Type	Required/ Optional
workflowId	The execution ID of the running workflow that contains the task to skip.	string	Required.
taskReferenceName	The reference name of the task to be skipped.	string	Required.

Query parameters

Parameter	Description	Type	Required/ Optional
taskInput	The skipped task’s inputs.	object	Optional.
taskOutput	The skipped task’s outputs.	object	Optional.

Example

{
  "taskInput": {
    "someInput": "Some task input"
  },
  "taskOutput": {
    "someOutput": "Some task output"
  }
}

Response

• Returns 200, indicating that the task has been skipped successfully.
• Returns 500 if the task has already been processed.
• Returns 400 if an invalid workflow execution ID is provided.

Examples

Skip a task

Request

curl -X 'PUT' \
  'https://<YOUR-SERVER-URL>/api/workflow/9002f320-0663-11f1-9b1b-c6f35360b671/skiptask/simple_ref' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response

Returns 200 OK, indicating that the task has been skipped successfully.

Skip a task with updated task inputs and outputs

Request

curl -X 'PUT' \
  'https://<YOUR-SERVER-URL>/api/workflow/fd7s06a839e9-71d6-11f0-af9d-8e9bff353733/skiptask/simple_ref' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "taskInput": {
    "input": "Task is skipped"
  },
  "taskOutput": {
    "output": "Skipped task from execution via API"
  }
}'

Response

Returns 200 OK, indicating that the task has been skipped successfully. You can verify the update by reviewing the task’s input and output in the workflow execution details.