Update a Workflow Job Template
patch
/api/v2/workflow_job_templates/{id}/
Make a PUT or PATCH request to this resource to update this workflow job template. The following fields may be modified:
name
: Name of this workflow job template. (string, required)-
description
: Optional description of this workflow job template. (string, default=""
) -
extra_vars
: (json, default=``) organization
: The organization used to determine access to this template. (id, default=``)survey_enabled
: (boolean, default=False
)allow_simultaneous
: (boolean, default=False
)ask_variables_on_launch
: (boolean, default=False
)inventory
: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)limit
: (string, default=""
)scm_branch
: (string, default=""
)ask_inventory_on_launch
: (boolean, default=False
)ask_scm_branch_on_launch
: (boolean, default=False
)ask_limit_on_launch
: (boolean, default=False
)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=``)ask_labels_on_launch
: (boolean, default=False
)ask_skip_tags_on_launch
: (boolean, default=False
)ask_tags_on_launch
: (boolean, default=False
)skip_tags
: (string, default=""
)job_tags
: (string, default=""
)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : WorkflowJobTemplate
Type:
Show Source
object
-
allow_simultaneous:
boolean
Title:
Allow simultaneous
-
ask_inventory_on_launch:
boolean
Title:
Ask inventory on launch
-
ask_labels_on_launch:
boolean
Title:
Ask labels on launch
-
ask_limit_on_launch:
boolean
Title:
Ask limit on launch
-
ask_scm_branch_on_launch:
boolean
Title:
Ask scm branch on launch
-
ask_skip_tags_on_launch:
boolean
Title:
Ask skip tags on launch
-
ask_tags_on_launch:
boolean
Title:
Ask tags on launch
-
ask_variables_on_launch:
boolean
Title:
Ask variables on launch
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
extra_vars:
string
Title:
Extra vars
-
id:
integer
Title:
ID
Read Only:true
-
inventory:
integer
Title:
Inventory
Inventory applied as a prompt, assuming job template prompts for inventory -
job_tags:
string
Title:
Job tags
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
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
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
-
organization:
integer
Title:
Organization
The organization used to determine access to this template. - related: string
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
survey_enabled:
boolean
Title:
Survey enabled
-
type:
string
Title:
Type
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_service:
string
Title:
Webhook service
Allowed Values:[ "github", "gitlab", "bitbucket_dc" ]
Service that webhook requests will be accepted from
Response
Supported Media Types
- application/json
200 Response
Root Schema : WorkflowJobTemplate
Type:
Show Source
object
-
allow_simultaneous:
boolean
Title:
Allow simultaneous
-
ask_inventory_on_launch:
boolean
Title:
Ask inventory on launch
-
ask_labels_on_launch:
boolean
Title:
Ask labels on launch
-
ask_limit_on_launch:
boolean
Title:
Ask limit on launch
-
ask_scm_branch_on_launch:
boolean
Title:
Ask scm branch on launch
-
ask_skip_tags_on_launch:
boolean
Title:
Ask skip tags on launch
-
ask_tags_on_launch:
boolean
Title:
Ask tags on launch
-
ask_variables_on_launch:
boolean
Title:
Ask variables on launch
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
extra_vars:
string
Title:
Extra vars
-
id:
integer
Title:
ID
Read Only:true
-
inventory:
integer
Title:
Inventory
Inventory applied as a prompt, assuming job template prompts for inventory -
job_tags:
string
Title:
Job tags
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
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
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
-
organization:
integer
Title:
Organization
The organization used to determine access to this template. - related: string
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
survey_enabled:
boolean
Title:
Survey enabled
-
type:
string
Title:
Type
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_service:
string
Title:
Webhook service
Allowed Values:[ "github", "gitlab", "bitbucket_dc" ]
Service that webhook requests will be accepted from