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: GitLab
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="")
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : schema
Type:
Show Source
object-
allow_simultaneous(optional):
boolean
-
description(optional):
string
-
extra_vars(optional):
string
-
inventory(optional):
integer
Inventory applied as a prompt, assuming job template prompts for inventory
-
is_sliced_job(optional):
boolean
-
job_template(optional):
string
If automatically created for a sliced job run, the job template the workflow job was created from.
-
limit(optional):
string
-
name:
string
-
scm_branch(optional):
string
-
webhook_credential(optional):
integer
Personal Access Token for posting back the status to the service API
-
webhook_guid(optional):
string
Unique identifier of the event that triggered this webhook
-
webhook_service(optional):
string
Service that webhook requests will be accepted from
-
workflow_job_template(optional):
string