Jump to

• Request
• Response

Create a Workflow Job Template Node for a Workflow Job Template Node

post

/api/v2/workflow_job_template_nodes/{id}/failure_nodes/

Make a POST request to this resource with the following workflow job template node fields to create a new workflow job template node associated with this workflow job template node.

• extra_data: (json, default={})
• inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
• scm_branch: (string, default="")
• job_type: (choice)
  • None: --------- (default)
  • "": ---------
  • run: Run
  • check: Check
• job_tags: (string, default="")
• skip_tags: (string, default="")
• limit: (string, default="")
• diff_mode: (boolean, default=None)
• verbosity: (choice)
  • None: --------- (default)
  • 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, default=``)
• forks: (integer, default=None)
• job_slice_count: (integer, default=None)
• timeout: (integer, default=None)
• workflow_job_template: (id, required)

• unified_job_template: (id, default=``)

• 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, default=False)

• identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

Add Workflow Job Template Nodes for a Workflow Job Template Node:

Make a POST request to this resource with only an id field to associate an existing workflow job template node with this workflow job template node.

Remove Workflow Job Template Nodes from this Workflow Job Template Node:

Make a POST request to this resource with id and disassociate fields to remove the workflow job template node from this workflow job template node without deleting the workflow job template node.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root 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
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root 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
}

Back to Top