Skip to main content

Skip Task in Workflow Execution

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

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

Path parameters

ParameterDescriptionTypeRequired/ Optional
workflowIdThe execution ID of the running workflow that contains the task to be skipped.stringRequired.
taskReferenceNameThe reference name of the task to be skipped.stringRequired.

Query parameters

ParameterDescriptionTypeRequired/ Optional
skipTaskRequestContains the skipped task’s inputs and outputs.objectRequired.
skipTaskRequest. taskInputThe skipped task’s inputs.objectOptional.
skipTaskRequest. taskOutputThe skipped task’s outputs.objectOptional.

Examples

Skip a task

Request

curl -X 'PUT' \
'https://<YOUR_CLUSTER>o/api/workflow/18f871a1-d3f8-11ef-a114-0af1b159704e/skiptask/someTask_ref' \
-H 'accept: */*' \
-H 'X-Authorization: <TOKEN>'

Response

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