Workflow Job Template Workflow Node List
post
/api/v2/workflow_job_templates/{id}/workflow_nodes/
Workflow nodes reference templates to execute and define the ordering in which to execute them. After a job in this workflow finishes, the subsequent actions are to:
- run nodes contained in "failure_nodes" or "always_nodes" if job failed
- run nodes contained in "success_nodes" or "always_nodes" if job succeeded
The workflow job is marked as successful if all of the jobs running as
a part of the workflow job have completed, and the workflow job has not
been canceled. Even if a job within the workflow has failed, the workflow
job will not be marked as failed.
Create a Workflow Job Template Node for a Workflow Job Template:
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.
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: Runcheck: 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) -
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")
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : WorkflowJobTemplateNode
Type:
Show Source
object-
all_parents_must_converge:
boolean
Title:
All parents must convergeIf 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:
trueUnique Items Required:true -
created:
string
Title:
CreatedRead Only:true -
diff_mode:
boolean
Title:
Diff mode -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
extra_data:
object Extra data
Title:
Extra data -
failure_nodes:
array failure_nodes
Read Only:
trueUnique Items Required:true -
forks:
integer
Title:
ForksMinimum Value:0 -
id:
integer
Title:
IDRead Only:true -
identifier:
string
Title:
IdentifierMinimum Length:1Maximum Length:512Default Value:00000000-0000-0000-0000-000000000000An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. -
inventory:
integer
Title:
InventoryInventory applied as a prompt, assuming job template prompts for inventory -
job_slice_count:
integer
Title:
Job slice countMinimum Value:0 -
job_tags:
string
Title:
Job tags -
job_type:
string
Title:
Job typeAllowed Values:[ "run", "check" ] -
limit:
string
Title:
Limit -
modified:
string
Title:
ModifiedRead Only:true - related: string
-
scm_branch:
string
Title:
Scm branch -
skip_tags:
string
Title:
Skip tags -
success_nodes:
array success_nodes
Read Only:
trueUnique Items Required:true -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
timeout:
integer
Title:
Timeout -
type:
string
Title:
TypeRead Only:true -
unified_job_template:
integer
Title:
Unified job template -
url:
string
Title:
UrlRead Only:true -
verbosity:
string
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ] -
workflow_job_template(required):
string
Title:
Workflow job template
Nested Schema : Extra data
Type:
objectTitle:
Extra dataResponse
Supported Media Types
- application/json
201 Response
Root Schema : WorkflowJobTemplateNode
Type:
Show Source
object-
all_parents_must_converge:
boolean
Title:
All parents must convergeIf 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:
trueUnique Items Required:true -
created:
string
Title:
CreatedRead Only:true -
diff_mode:
boolean
Title:
Diff mode -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
extra_data:
object Extra data
Title:
Extra data -
failure_nodes:
array failure_nodes
Read Only:
trueUnique Items Required:true -
forks:
integer
Title:
ForksMinimum Value:0 -
id:
integer
Title:
IDRead Only:true -
identifier:
string
Title:
IdentifierMinimum Length:1Maximum Length:512Default Value:00000000-0000-0000-0000-000000000000An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. -
inventory:
integer
Title:
InventoryInventory applied as a prompt, assuming job template prompts for inventory -
job_slice_count:
integer
Title:
Job slice countMinimum Value:0 -
job_tags:
string
Title:
Job tags -
job_type:
string
Title:
Job typeAllowed Values:[ "run", "check" ] -
limit:
string
Title:
Limit -
modified:
string
Title:
ModifiedRead Only:true - related: string
-
scm_branch:
string
Title:
Scm branch -
skip_tags:
string
Title:
Skip tags -
success_nodes:
array success_nodes
Read Only:
trueUnique Items Required:true -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
timeout:
integer
Title:
Timeout -
type:
string
Title:
TypeRead Only:true -
unified_job_template:
integer
Title:
Unified job template -
url:
string
Title:
UrlRead Only:true -
verbosity:
string
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ] -
workflow_job_template(required):
string
Title:
Workflow job template
Nested Schema : Extra data
Type:
objectTitle:
Extra data