2.1 Manage Workflow Definitions

Create, validate, update, retrieve, search, and delete workflow definitions. You can retrieve a specific definition by name and version, list all definitions, get only the latest versions, or view workflow names and versions without loading full definition bodies.

A workflow definition is the blueprint for a workflow. It defines the workflow name, version, tasks, task reference names, inputs, transitions, and other metadata that determine the execution behavior. A workflow execution is a running or completed instance of a workflow definition.

You can create workflow definitions visually with Workflow Builder or by providing JSON, validate definitions before saving them, view existing definitions, update definitions, clone definitions, and delete a specific version when it is no longer required.

Topics

• Specify Values for Workflow Definition Options
  Specify the workflow definition options before you add tasks and save the workflow.
• Define a Workflow Using Workflow Builder
  Use Workflow Builder to create a workflow definition visually. You can add tasks, arrange the flow, configure task properties, and define how tasks interact without writing the full JSON manually.
• Define a Workflow Using JSON
  Define a workflow by providing its JSON definition directly. Use this option when you want precise control over workflow metadata, task configuration, versions, inputs, and flow behavior. You can validate the JSON definition before saving the workflow definition.
• View a Workflow Definition
  View a workflow definition by name and, optionally, by version. You can also list all workflow definitions, search definitions, view only the latest versions, or retrieve workflow names and versions without loading the full definition body.
• Update a Workflow Definition
  Update an existing workflow definition when you need to change its task configuration, metadata, inputs, or flow behavior. The update operation supports one or more workflow definitions. To rename a workflow, create a new workflow definition with the new name instead of changing the existing workflow name.
• Clone a Workflow Definition
  Clone a workflow definition when you want to create a new definition based on an existing one. Cloning starts from the selected definition's JSON or visual structure, then saves it as a separate workflow definition, typically with a new name or version.
• Delete a Workflow Definition
  Delete a workflow definition version when it is no longer required. Deletion is performed by workflow name and version. Deleting a workflow definition does not delete workflow executions that were already created from that definition.