Run, resume, and retry workflow jobs¶

Start workflow jobs, track jobs, nodes, file executions, and results, and pause, resume, rerun, retry, cancel, or delete jobs when needed. This page does not modify workflow definitions; maintain workflows and templates in Manage workflows and templates.

Prerequisites¶

Prepare credentials that can access the target workspace and the ID of the workflow to run. For service endpoints, authentication, and general request formats, see Prepare to call an API.

Before pausing, resuming, retrying, canceling, rerunning, or deleting an existing job, obtain its ID from the job list or details.

Call sequence¶

Start a workflow job and retain its job ID. For an existing job, list or get details first to identify the current object.
Query job details, nodes, file execution records, and job results to inspect the run, nodes, file processing, and output separately.
Refresh status to update current job information. To stop or continue temporarily, use pause and resume in that order.
When processing must run again, get the rerun plan first, then rerun from a specified node, or retry individual or batch jobs. Cancel a rerun or job when needed.
Delete a job only after confirming that it no longer needs to be retained.

API operations¶

Start and view jobs¶

What you need to do	API operation	Use it when
Start a workflow job	Start a workflow job	Create one run for a workflow.
Query workflow jobs	List workflow jobs	Find a job or obtain a target job ID.
Query workflow job details	Get workflow job details	Inspect current information for one job.
Query workflow job nodes	Get a workflow job node	View nodes in a job.
Query file execution records	List file executions	Inspect file-processing records.
Query workflow job results	Get a workflow job result	Obtain or inspect a job result.
Refresh workflow job status	Refresh workflow job status	Refresh the current job status.

Control jobs¶

What you need to do	API operation	Use it when
Pause a workflow job	Pause a workflow job	Stop a target job temporarily.
Resume a workflow job	Resume a workflow job	Continue a paused job.
Cancel a workflow job	Cancel a workflow job	You no longer need the target job to continue.
Delete a workflow job	Delete a workflow job	You confirmed that the job no longer needs to be retained.

Rerun and retry¶

What you need to do	API operation	Use it when
Query a node-rerun plan	Get a node-rerun plan	Confirm an available plan before rerunning from a specified node.
Rerun from a specified node	Create a node rerun	Start processing again from a selected node.
Query workflow reruns	List workflow reruns	Find existing rerun records.
Query workflow rerun details	Get a workflow rerun	Inspect current information for one rerun.
Cancel a workflow rerun	Cancel a workflow rerun	You no longer need the target rerun to continue.
Retry a workflow job	Retry a workflow job	Retry one job.
Retry workflow jobs in bulk	Batch retry workflow jobs	Retry multiple jobs together.

Confirm the result¶

After starting, resuming, canceling, rerunning, or retrying, use Get workflow job details or Get a workflow rerun to inspect current information. To confirm output, use Get a workflow job result.

Limitations and notes¶

Starting, resuming, retrying, or rerunning means the relevant operation was initiated. Job details, nodes, file execution records, and results confirm later progress.
Before cancellation, deletion, or rerunning, confirm the impact on the target job and its output.

Next steps¶

Last updated on Sep 3, 2026