Bulk Job Launch
get
/api/v2/bulk/job_launch/
This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.
Request
Supported Media Types
- application/json
Query Parameters
-
page: integer
A page number within the paginated result set.
-
page_size: integer
Number of results to return per page.
-
search: string
A search term.
Response
Supported Media Types
- application/json
200 Response
Nested Schema : BulkJobLaunch
Type:
Show Source
object-
description:
string
Title:
DescriptionMinimum Length:1 -
extra_vars:
object Extra vars
Title:
Extra vars -
inventory:
integer
Title:
Inventory -
job_tags:
string
Title:
Job tagsMinimum Length:1 -
jobs(required):
array jobs
List of jobs to be launched, JSON. e.g. [{"unified_job_template": 7}, {"unified_job_template": 10}]
-
limit:
string
Title:
LimitMinimum Length:1 -
name:
string
Title:
NameMaximum Length:512Default Value:Bulk Job Launch -
organization:
integer
Title:
OrganizationInherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically. -
scm_branch:
string
Title:
Scm branchMinimum Length:1 -
skip_tags:
string
Title:
Skip tagsMinimum Length:1
Nested Schema : Extra vars
Type:
objectTitle:
Extra varsNested Schema : jobs
Type:
arrayList of jobs to be launched, JSON. e.g. [{"unified_job_template": 7}, {"unified_job_template": 10}]
Show Source
-
Array of:
object BulkJobNode
List of jobs to be launched, JSON. e.g. [{"unified_job_template": 7}, {"unified_job_template": 10}]
Nested Schema : BulkJobNode
Type:
objectList of jobs to be launched, JSON. e.g. [{"unified_job_template": 7}, {"unified_job_template": 10}]
Show Source
-
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 -
credentials:
array credentials
-
diff_mode:
boolean
Title:
Diff mode -
do_not_run:
boolean
Title:
Do not runIndicates 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 environmentMinimum Value:1 -
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:
IdentifierMaximum Length:512An identifier coresponding to the workflow job template node that this node was created from. -
instance_groups:
array instance_groups
-
inventory:
integer
Title:
InventoryMinimum Value:1 -
job:
integer
Title:
Job -
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" ] -
labels:
array labels
-
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(required):
integer
Title:
Unified job templateMinimum Value:1Primary key of the template for this job, can be a job template or inventory source. -
url:
string
Title:
UrlRead Only:true -
verbosity:
string
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ] -
workflow_job:
string
Title:
Workflow job
Nested Schema : Extra data
Type:
objectTitle:
Extra data