List Schedules for a System Job Template
/api/v2/system_job_templates/{id}/schedules/
Make a GET request to this resource to retrieve a list of schedules associated with the selected system job template.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count field indicates the total number of schedules
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 schedule records.
Results
Each schedule data structure includes the following fields:
rrule: A value representing the schedules iCal recurrence rule. (string)id: Database ID for this schedule. (integer)type: Data type for this schedule. (choice)url: URL for this schedule. (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 schedule was created. (datetime)modified: Timestamp when this schedule was last modified. (datetime)name: Name of this schedule. (string)description: Optional description of this schedule. (string)extra_data: (json)inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)scm_branch: (string)job_type: (choice)None: ---------"": ---------run: Runcheck: Check
job_tags: (string)skip_tags: (string)limit: (string)diff_mode: (boolean)verbosity: (choice)None: ---------0: 0 (Normal)1: 1 (Verbose)2: 2 (More Verbose)3: 3 (Debug)4: 4 (Connection Debug)5: 5 (WinRM Debug)
execution_environment: The container image to be used for execution. (id)forks: (integer)job_slice_count: (integer)timeout: (integer)unified_job_template: (id)enabled: Enables processing of this schedule. (boolean)dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)next_run: The next time that the scheduled action will run. (datetime)timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)
Sorting
To specify that schedules 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-
created:
string
Title:
CreatedRead Only:true -
description:
string
Title:
Description -
diff_mode:
boolean
Title:
Diff mode -
dtend:
string(date-time)
Title:
DtendRead Only:trueThe last occurrence of the schedule occurs before this time, aftewards the schedule expires. -
dtstart:
string(date-time)
Title:
DtstartRead Only:trueThe first occurrence of the schedule occurs on or after this time. -
enabled:
boolean
Title:
EnabledDefault Value:trueEnables processing of this schedule. -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
extra_data:
object Extra data
Title:
Extra data -
forks:
integer
Title:
ForksMinimum Value:0 -
id:
integer
Title:
IDRead Only:true -
inventory:
integer
Title:
InventoryInventory applied as a prompt, assuming job template prompts for inventory -
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" ] -
limit:
string
Title:
Limit -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:512 -
next_run:
string(date-time)
Title:
Next runRead Only:trueThe next time that the scheduled action will run. - related: string
-
rrule(required):
string
Title:
RruleMinimum Length:1A value representing the schedules iCal recurrence rule. -
scm_branch:
string
Title:
Scm branch -
skip_tags:
string
Title:
Skip tags -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
timeout:
integer
Title:
Timeout -
timezone:
string
Title:
TimezoneRead Only:trueThe timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. -
type:
string
Title:
TypeRead Only:true -
unified_job_template(required):
integer
Title:
Unified job template -
until:
string
Title:
UntilRead Only:trueThe date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned -
url:
string
Title:
UrlRead Only:true -
verbosity:
string
Title:
VerbosityAllowed Values:[ "0", "1", "2", "3", "4", "5" ]
objectExtra data