Create a Workflow Job for a Job Template
post
/api/v2/job_templates/{id}/slice_workflow_jobs/
Make a POST request to this resource with the following workflow job fields to create a new workflow job associated with this job template.
name
: Name of this workflow job. (string, required)-
description
: Optional description of this workflow job. (string, default=""
) -
workflow_job_template
: (id, default=``) extra_vars
: (json, default=``)-
allow_simultaneous
: (boolean, default=False
) -
is_sliced_job
: (boolean, default=False
) inventory
: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)limit
: (string, default=""
)scm_branch
: (string, default=""
)webhook_service
: Service that webhook requests will be accepted from (choice)""
: ---------github
: GitHubgitlab
: GitLabbitbucket_dc
: BitBucket DataCenter
webhook_credential
: Personal Access Token for posting back the status to the service API (id, default=``)webhook_guid
: Unique identifier of the event that triggered this webhook (string, default=""
)skip_tags
: (string, default=""
)job_tags
: (string, default=""
)
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : WorkflowJobList
Type:
Show Source
object
-
allow_simultaneous:
boolean
Title:
Allow simultaneous
-
canceled_on:
string(date-time)
Title:
Canceled on
Read Only:true
The date and time when the cancel request was sent. -
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
elapsed:
string(decimal)
Title:
Elapsed
Read Only:true
Elapsed time in seconds that the job ran. -
extra_vars:
string
Title:
Extra vars
-
failed:
boolean
Title:
Failed
Read Only:true
-
finished:
string(date-time)
Title:
Finished
Read Only:true
The date and time the job finished execution. -
id:
integer
Title:
ID
Read Only:true
-
inventory:
integer
Title:
Inventory
Inventory applied as a prompt, assuming job template prompts for inventory -
is_sliced_job:
boolean
Title:
Is sliced job
-
job_explanation:
string
Title:
Job explanation
Read Only:true
Minimum Length:1
A status field to indicate the state of the job if it wasn't able to run and capture stdout -
job_tags:
string
Title:
Job tags
-
job_template:
string
Title:
Job template
If automatically created for a sliced job run, the job template the workflow job was created from. -
launch_type:
string
Title:
Launch type
Read Only:true
Allowed Values:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
-
launched_by:
string
Title:
Launched by
Read Only:true
-
limit:
string
Title:
Limit
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
started:
string(date-time)
Title:
Started
Read Only:true
The date and time the job was queued for starting. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
unified_job_template:
string
Title:
unified job template
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
webhook_credential:
integer
Title:
Webhook credential
Personal Access Token for posting back the status to the service API -
webhook_guid:
string
Title:
Webhook guid
Maximum Length:128
Unique identifier of the event that triggered this webhook -
webhook_service:
string
Title:
Webhook service
Allowed Values:[ "github", "gitlab", "bitbucket_dc" ]
Service that webhook requests will be accepted from -
work_unit_id:
string
Title:
Work unit id
Read Only:true
Minimum Length:1
The Receptor work unit ID associated with this job. -
workflow_job_template:
string
Title:
Workflow job template
Response
Supported Media Types
- application/json
201 Response
Root Schema : WorkflowJobList
Type:
Show Source
object
-
allow_simultaneous:
boolean
Title:
Allow simultaneous
-
canceled_on:
string(date-time)
Title:
Canceled on
Read Only:true
The date and time when the cancel request was sent. -
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
elapsed:
string(decimal)
Title:
Elapsed
Read Only:true
Elapsed time in seconds that the job ran. -
extra_vars:
string
Title:
Extra vars
-
failed:
boolean
Title:
Failed
Read Only:true
-
finished:
string(date-time)
Title:
Finished
Read Only:true
The date and time the job finished execution. -
id:
integer
Title:
ID
Read Only:true
-
inventory:
integer
Title:
Inventory
Inventory applied as a prompt, assuming job template prompts for inventory -
is_sliced_job:
boolean
Title:
Is sliced job
-
job_explanation:
string
Title:
Job explanation
Read Only:true
Minimum Length:1
A status field to indicate the state of the job if it wasn't able to run and capture stdout -
job_tags:
string
Title:
Job tags
-
job_template:
string
Title:
Job template
If automatically created for a sliced job run, the job template the workflow job was created from. -
launch_type:
string
Title:
Launch type
Read Only:true
Allowed Values:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
-
launched_by:
string
Title:
Launched by
Read Only:true
-
limit:
string
Title:
Limit
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
started:
string(date-time)
Title:
Started
Read Only:true
The date and time the job was queued for starting. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
unified_job_template:
string
Title:
unified job template
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
webhook_credential:
integer
Title:
Webhook credential
Personal Access Token for posting back the status to the service API -
webhook_guid:
string
Title:
Webhook guid
Maximum Length:128
Unique identifier of the event that triggered this webhook -
webhook_service:
string
Title:
Webhook service
Allowed Values:[ "github", "gitlab", "bitbucket_dc" ]
Service that webhook requests will be accepted from -
work_unit_id:
string
Title:
Work unit id
Read Only:true
Minimum Length:1
The Receptor work unit ID associated with this job. -
workflow_job_template:
string
Title:
Workflow job template