Oracle Linux Automation Manager CLI and API Reference Guide

List Workflow Job Template Nodes for a Workflow Job Template Node

get

/api/v2/workflow_job_template_nodes/{id}/success_nodes/

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

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)
execution_environment: The container image to be used for execution. (id)
forks: (integer)
job_slice_count: (integer)
timeout: (integer)
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

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Query Parameters

page: integer

A page number within the paginated result set.
page_size: integer

Number of results to return per page.
search: string

A search term.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/WorkflowJobTemplateNode"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object WorkflowJobTemplateNode

{
    "items":{
        "$ref":"#/definitions/WorkflowJobTemplateNode"
    },
    "type":"array"
}

Nested Schema : WorkflowJobTemplateNode

Type: object

Show Source

all_parents_must_converge: boolean

Title: 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
always_nodes: array always_nodes

Read Only: true

Unique Items Required: true
created: string

Title: Created

Read Only: true
diff_mode: boolean

Title: Diff mode
execution_environment: integer

Title: Execution environment

The container image to be used for execution.
extra_data: object Extra data

Title: Extra data
failure_nodes: array failure_nodes

Read Only: true

Unique Items Required: true
forks: integer

Title: Forks

Minimum Value: 0
id: integer

Title: ID

Read Only: true
identifier: string

Title: Identifier

Minimum Length: 1

Maximum Length: 512

Default Value: 00000000-0000-0000-0000-000000000000

An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.
inventory: integer

Title: Inventory

Inventory applied as a prompt, assuming job template prompts for inventory
job_slice_count: integer

Title: Job slice count

Minimum Value: 0
job_tags: string

Title: Job tags
job_type: string

Title: Job type

Allowed Values: [ "run", "check" ]
limit: string

Title: Limit
modified: string

Title: Modified

Read Only: true
related: string

Title: Related

Read Only: true
scm_branch: string

Title: Scm branch
skip_tags: string

Title: Skip tags
success_nodes: array success_nodes

Read Only: true

Unique Items Required: true
summary_fields: string

Title: Summary fields

Read Only: true
timeout: integer

Title: Timeout
type: string

Title: Type

Read Only: true
unified_job_template: integer

Title: Unified job template
url: string

Title: Url

Read Only: true
verbosity: string

Title: Verbosity

Allowed Values: [ "0", "1", "2", "3", "4", "5" ]
workflow_job_template(required): string

Title: Workflow job template

{
    "properties":{
        "all_parents_must_converge":{
            "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node",
            "title":"All parents must converge",
            "type":"boolean",
            "x-nullable":true
        },
        "always_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "failure_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "identifier":{
            "default":"00000000-0000-0000-0000-000000000000",
            "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.",
            "maxLength":"512",
            "minLength":"1",
            "title":"Identifier",
            "type":"string",
            "x-nullable":true
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "success_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        },
        "workflow_job_template":{
            "title":"Workflow job template",
            "type":"string"
        }
    },
    "required":[
        "workflow_job_template"
    ],
    "type":"object"
}

Nested Schema : always_nodes

Type: array

Read Only: true

Unique Items Required: true

Show Source

Array of: integer

{
    "items":{
        "type":"integer"
    },
    "readOnly":true,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : Extra data

Type: object

Title: Extra data

Nested Schema : failure_nodes

Type: array

Read Only: true

Unique Items Required: true

Show Source

Array of: integer

{
    "items":{
        "type":"integer"
    },
    "readOnly":true,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : success_nodes

Type: array

Read Only: true

Unique Items Required: true

Show Source

Array of: integer

{
    "items":{
        "type":"integer"
    },
    "readOnly":true,
    "type":"array",
    "uniqueItems":true
}