Manage workflows and templates¶
Create, view, update, pause, or delete workflows, and manage reusable workflow templates. This page handles workflow definitions and templates. To start, resume, or retry a specific job, see Run, resume, and retry workflow jobs.
Prerequisites¶
Prepare credentials that can access the target workspace. For service endpoints, authentication, and general request formats, see Prepare to call an API.
Before updating, pausing, resuming, or deleting, obtain target IDs from the workflow or template list or details.
Call sequence¶
List workflows and templates to decide whether to reuse an existing object or maintain a target object.
Update a workflow or template to adjust its definition. Create a workflow when you need to use it for later jobs.
Pause a workflow to stop it temporarily, then resume it to continue. Confirm current information through details.
Delete an object only after confirming it is no longer needed.
API operations¶
Manage workflows¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Query workflows |
Find a workflow or obtain a target ID. |
|
Query workflow details |
Inspect current information for one workflow. |
|
Update a workflow |
Modify an existing workflow. |
|
Create a workflow |
You prepared workflow DSL and need to create a workflow. |
|
Pause a workflow |
Stop a workflow temporarily. |
|
Resume a workflow |
Continue a paused workflow. |
|
Delete a workflow |
You confirmed that the workflow is no longer needed. |
Manage workflow templates¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Query workflow templates |
Find a reusable template or obtain a template ID. |
|
Query workflow template details |
Inspect current information for one template. |
|
Create a workflow template |
Add a reusable template. |
|
Update a workflow template |
Modify an existing template. |
|
Delete a workflow template |
You confirmed that the template is no longer needed. |
Confirm the result¶
After creation, update, pause, or resume, use Get workflow details to confirm current workflow information. After creating, updating, or deleting a template, use template details or the list to confirm the target object.
Limitations and notes¶
Workflow definitions and individual jobs are different objects. This page does not confirm actual job results.
Before deleting a workflow or template, confirm that no later operation still depends on it.