Schedule Run の実行レコードを一覧表示します。
GET /api/v1/forward/schedule_runs
Identity の Schedule Run を一覧表示します。schedule_id を渡すと、結果を 1 つの Schedule に絞り込めます。
この API は PAT または管理者 SAT のみを許可します。Identity-bound SAT は、自身の identity_id を指定しても呼び出せません。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または管理者 SAT> |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identity_id | string | Yes | - | 実行を所有する Forward Identity ID。 |
schedule_id | string | No | - | Schedule ID でフィルタリングします。 |
status | string | No | - | pending、running、completed、failed、または skipped でフィルタリングします。 |
trigger_type | string | No | - | schedule または manual でフィルタリングします。 |
has_error | boolean | No | - | エラーの有無で実行をフィルタリングします。 |
limit | integer | No | 20 | 1 ページあたりの項目数。最大 100。 |
after_id | string | No | - | 指定した Run ID より後のレコードのカーソル。 |
before_id | string | No | - | 指定した Run ID より前のレコードのカーソル。 |
sort_by | string | No | created_at | ソート項目:created_at または triggered_at。 |
order | string | No | desc | ソート方向:asc または desc。 |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
data | Schedule Run オブジェクトの配列 | 現在のページのレコード。 |
first_id | string|null | このページの最初の実行の ID。 |
last_id | string|null | このページの最後の実行の ID。 |
has_more | boolean | さらにレコードが残っているかどうか。 |
Errors
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 400 | invalid_request_error | invalid_identity | identity_id が未指定または空です。 |
| 400 | invalid_request_error | invalid_request | status、trigger_type、sort_by、order が不正、after_id と before_id が同時に指定されている、または identity_id、schedule_id、カーソルなどの文字列に未対応の制御文字が含まれています。 |
| 400 | invalid_request_error | invalid_has_error | has_error を boolean として解析できません。 |
| 400 | invalid_request_error | invalid_limit | limit が 1~100 の範囲外、または整数ではありません。 |
| 401 | authentication_error | - | PAT または SAT が無効または期限切れです。 |
| 403 | permission_error | - | Identity-bound SAT が PAT または管理者 SAT のみを許可する API を呼び出しています。message は admin service account token required で、レスポンスに error.code は含まれません。 |
Notes
- Schedule Run は独立したリソースです。
- デフォルトでは
(created_at, run_id)の降順です。sort_by=triggered_atでは(triggered_at, run_id)で安定ソートします。 after_idとbefore_idは同時指定できません。ソート変更時はページネーションを最初からやり直してください。- v1 互換のため、現在の owner/Identity で見つからない有効なカーソルは無視され、先頭ページを返します。この互換動作には依存せず、同じ owner/Identity、
sort_by、orderで返されたカーソルのみ再利用してください。 completed、failed、skippedは終了ステータスです。push_statusは IM ストリーミング配信を表し、メインの実行statusとは独立しています。