Workflow nodes reference templates to execute and define the ordering in which to execute them. After a job in this workflow finishes, the subsequent actions are to:

• run nodes contained in "failure_nodes" or "always_nodes" if job failed
• run nodes contained in "success_nodes" or "always_nodes" if job succeeded

The workflow job is marked as successful if all of the jobs running as a part of the workflow job have completed, and the workflow job has not been canceled. Even if a job within the workflow has failed, the workflow job will not be marked as failed.

List Workflow Job Template Nodes for a Workflow Job Template:

Make a GET request to this resource to retrieve a list of workflow job template nodes associated with the selected workflow job template.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of workflow job template nodes found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more workflow job template node records.

Results

Each workflow job template node data structure includes the following fields:

• id: Database ID for this workflow job template node. (integer)
• type: Data type for this workflow job template node. (choice)
• url: URL for this workflow job template node. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this workflow job template node was created. (datetime)
• modified: Timestamp when this workflow job template node was last modified. (datetime)
• extra_data: (json)
• inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
• scm_branch: (string)
• job_type: (choice)
  • None: ---------
  • "": ---------
  • run: Run
  • check: Check
• job_tags: (string)
• skip_tags: (string)
• limit: (string)
• diff_mode: (boolean)
• verbosity: (choice)
  • None: ---------
  • 0: 0 (Normal)
  • 1: 1 (Verbose)
  • 2: 2 (More Verbose)
  • 3: 3 (Debug)
  • 4: 4 (Connection Debug)
  • 5: 5 (WinRM Debug)
• workflow_job_template: (id)
• unified_job_template: (id)
• success_nodes: (field)
• failure_nodes: (field)
• always_nodes: (field)
• all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)
• identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)

Sorting

To specify that workflow job template nodes are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme