List Workflow Job Nodes for a Workflow Job Node

get

/api/v2/workflow_job_nodes/{id}/success_nodes/

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

The resulting data structure contains:

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

The count field indicates the total number of workflow job 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 node records.

Results

Each workflow job node data structure includes the following fields:

  • id: Database ID for this workflow job node. (integer)
  • type: Data type for this workflow job node. (choice)
  • url: URL for this workflow job 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 node was created. (datetime)
  • modified: Timestamp when this workflow job 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)
  • job: (id)
  • workflow_job: (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)
  • do_not_run: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)
  • identifier: An identifier coresponding to the workflow job template node that this node was created from. (string)

Sorting

To specify that workflow job 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 Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top