List Schedules for a Project
/api/v2/projects/{id}/schedules/
Make a GET request to this resource to retrieve a list of schedules associated with the selected project.
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)
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
: (field)until
: (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 Oracle Linux Automation Manaer) 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.