1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Schedules

List Schedules

get

/api/v2/schedules/

Make a GET request to this resource to retrieve the list of schedules.

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: Run
    • check: 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

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : results
Type: array
Show Source
Nested Schema : Schedule
Type: object
Show Source
Nested Schema : Extra data
Type: object
Title: Extra data
Back to Top