Documentation

スケジュールの API エンドポイント

このリソースに GET リクエストを実行して、スケジュールリストを取得します。

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

返されるデータ構造には以下のものが含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

count フィールドはクエリーで見つかったスケジュールの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはスケジュールのレコードが一覧表示されますが、ゼロの場合もあります。

結果

各スケジュールのデータ構造には以下のフィールドが含まれます。

  • id: スケジュールのデータベース ID (整数)
  • type: スケジュールのデータタイプ (複数選択)
    • schedule: スケジュール
  • url: スケジュールの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • created: スケジュール作成時のタイムスタンプ (日時)
  • modified: スケジュールの最終更新時のタイムスタンプ (日時)
  • name: (文字列)
  • description: (文字列)
  • unified_job_template: (フィールド)
  • enabled: (ブール値)
  • dtstart: (日時)
  • dtend: (日時)
  • rrule: (文字列)
  • next_run: (日時)
  • extra_data: (フィールド)

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

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