List Workflow Job Templates for an Organization
/api/v2/organizations/{id}/workflow_job_templates/
Make a GET request to this resource to retrieve a list of workflow job templates associated with the selected organization.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count
field indicates the total number of workflow job templates
found for the given query. The next
and previous
fields provides links to
additional results if there are more than will fit on a single page. The
results
list contains zero or more workflow job template records.
Results
Each workflow job template data structure includes the following fields:
id
: Database ID for this workflow job template. (integer)type
: Data type for this workflow job template. (choice)url
: URL for this workflow job template. (string)related
: Data structure with URLs of related resources. (object)summary_fields
: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created
: Timestamp when this workflow job template was created. (datetime)modified
: Timestamp when this workflow job template was last modified. (datetime)name
: Name of this workflow job template. (string)description
: Optional description of this workflow job template. (string)last_job_run
: (datetime)last_job_failed
: (boolean)next_job_run
: (datetime)status
: (choice)new
: Newpending
: Pendingwaiting
: Waitingrunning
: Runningsuccessful
: Successfulfailed
: Failederror
: Errorcanceled
: Cancelednever updated
: Never Updatedok
: OKmissing
: Missingnone
: No External Sourceupdating
: Updating
extra_vars
: (json)organization
: The organization used to determine access to this template. (id)survey_enabled
: (boolean)allow_simultaneous
: (boolean)ask_variables_on_launch
: (boolean)inventory
: Inventory applied as a prompt, assuming job template prompts for inventory (id)limit
: (string)scm_branch
: (string)ask_inventory_on_launch
: (boolean)ask_scm_branch_on_launch
: (boolean)ask_limit_on_launch
: (boolean)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)ask_labels_on_launch
: (boolean)ask_skip_tags_on_launch
: (boolean)ask_tags_on_launch
: (boolean)skip_tags
: (string)job_tags
: (string)
Sorting
To specify that workflow job templates are returned in a particular
order, use the order_by
query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash -
to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a
comma ,
:
?order_by=name,some_other_field
Pagination
Use the page_size
query string parameter to change the number of results
returned for each request. Use the page
query string parameter to retrieve
a particular page of results.
?page_size=100&page=2
The previous
and next
links returned with the results will set these query
string parameters automatically.
Searching
Use the search
query string parameter to perform a case-insensitive search
within all designated text fields of a model.
?search=findme
(Added in Ansible Tower 3.1.0) Search across related fields:
?related__search=findme
Request
- application/json
-
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
- application/json
200 Response
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