1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Workflow Job Template Nodes

Retrieve a Workflow Job Template Node

get

/api/v2/workflow_job_template_nodes/{id}/

Make GET request to this resource to retrieve a single workflow job template node record containing 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)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "all_parents_must_converge":false,
    "always_nodes":[
    ],
    "created":"2018-02-01T08:00:00.000000Z",
    "diff_mode":null,
    "extra_data":{
    },
    "failure_nodes":[
    ],
    "id":1,
    "identifier":"40d6cea4-eb84-4861-a1d0-bc4b09060a56",
    "inventory":null,
    "job_tags":null,
    "job_type":null,
    "limit":null,
    "modified":"2018-02-01T08:00:00.000000Z",
    "related":{
        "always_nodes":"/api/v2/workflow_job_template_nodes/1/always_nodes/",
        "create_approval_template":"/api/v2/workflow_job_template_nodes/1/create_approval_template/",
        "credentials":"/api/v2/workflow_job_template_nodes/1/credentials/",
        "failure_nodes":"/api/v2/workflow_job_template_nodes/1/failure_nodes/",
        "success_nodes":"/api/v2/workflow_job_template_nodes/1/success_nodes/",
        "unified_job_template":"/api/v2/job_templates/3/",
        "workflow_job_template":"/api/v2/workflow_job_templates/1/"
    },
    "scm_branch":null,
    "skip_tags":null,
    "success_nodes":[
    ],
    "summary_fields":{
        "unified_job_template":{
            "description":"",
            "id":3,
            "name":"test-job_template",
            "unified_job_type":"job"
        },
        "workflow_job_template":{
            "description":"",
            "id":1,
            "name":"test-workflow_job_template"
        }
    },
    "type":"workflow_job_template_node",
    "unified_job_template":3,
    "url":"/api/v2/workflow_job_template_nodes/1/",
    "verbosity":null,
    "workflow_job_template":1
}
Back to Top