Documentation

22. Schedules API Endpoint

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

GET /api/v1/schedules/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.050s

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.

22.1. Results

Each schedule data structure includes the following fields:

  • id: Database ID for this schedule. (integer)
  • type: Data type for this schedule. (multiple choice)
    • schedule: Schedule
  • 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. (object)
  • created: Timestamp when this schedule was created. (datetime)
  • modified: Timestamp when this schedule was last modified. (datetime)
  • name: (string)
  • description: (string)
  • unified_job_template: (field)
  • enabled: (boolean)
  • dtstart: (datetime)
  • dtend: (datetime)
  • rrule: (string)
  • next_run: (datetime)
  • extra_data: (field)

22.2. Reviewing the Options Endpoint

The Options Endpoint table offers a view of the Options for this endpoint. When viewing the endpoint in the browsable API, clicking the “Options” button gives you the raw JSON for the following:

name Schedules
description # List Schedules: Make a GET request to this resource to retrieve the list of schedules.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.4.8
types
0 schedule
actions
GET
id
type integer
label ID
help_text Database ID for this schedule.
type
type multiple choice
help_text Data type for this schedule.
choices
0
0 schedule
1 Schedule
url
type string
help_text URL for this schedule.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this schedule was created.
modified
type datetime
help_text Timestamp when this schedule was last modified.
name
type string
label name
description
type string
label description
unified_job_template
type field
enabled
type boolean
label enabled
dtstart
type datetime
label dtstart
dtend
type datetime
label dtend
rrule
type string
label rrule
next_run
type datetime
label next run
extra_data
type field
label extra data
search_fields
0 description
1 name