Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve a Workflow Job Node

get

/api/v2/workflow_job_nodes/{id}/

Make GET request to this resource to retrieve a single workflow job node record containing 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)
execution_environment: The container image to be used for execution. (id)
forks: (integer)
job_slice_count: (integer)
timeout: (integer)
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)

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : WorkflowJobNodeDetail

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
do_not_run: boolean

Title: 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.
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

Maximum Length: 512

An identifier coresponding to the workflow job template node that this node was created from.
inventory: integer

Title: Inventory

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

Title: Job
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: string

Title: Workflow job

{
    "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
        },
        "do_not_run":{
            "description":"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.",
            "title":"Do not run",
            "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":{
            "description":"An identifier coresponding to the workflow job template node that this node was created from.",
            "maxLength":"512",
            "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":{
            "title":"Job",
            "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":{
            "title":"Workflow job",
            "type":"string",
            "x-nullable":true
        }
    },
    "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
}