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

post

/api/v2/workflow_job_template_nodes/{id}/success_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
Path Parameters
Body ()
Root Schema : WorkflowJobTemplateNode
Type: object
Show Source
Nested Schema : always_nodes
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : Extra data
Type: object
Title: Extra data
Nested Schema : failure_nodes
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : success_nodes
Type: array
Read Only: true
Unique Items Required: true
Show Source
Back to Top

Response

Supported Media Types

201 Response

Body ()
Root Schema : WorkflowJobTemplateNode
Type: object
Show Source
Nested Schema : always_nodes
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : Extra data
Type: object
Title: Extra data
Nested Schema : failure_nodes
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : success_nodes
Type: array
Read Only: true
Unique Items Required: true
Show Source
Back to Top