Skip to main content

スケジュール実行を一覧表示する

Schedule Run の実行レコードを一覧表示します。

GET /api/v1/forward/schedule_runs Identity の Schedule Run を一覧表示します。schedule_id を渡すと、結果を 1 つの Schedule に絞り込めます。 この API は PAT または管理者 SAT のみを許可します。Identity-bound SAT は、自身の identity_id を指定しても呼び出せません。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT または管理者 SAT>

Query parameters

ParameterTypeRequiredDefaultDescription
identity_idstringYes-実行を所有する Forward Identity ID。
schedule_idstringNo-Schedule ID でフィルタリングします。
statusstringNo-pending、running、completed、failed、または skipped でフィルタリングします。
trigger_typestringNo-schedule または manual でフィルタリングします。
has_errorbooleanNo-エラーの有無で実行をフィルタリングします。
limitintegerNo201 ページあたりの項目数。最大 100。
after_idstringNo-指定した Run ID より後のレコードのカーソル。
before_idstringNo-指定した Run ID より前のレコードのカーソル。
sort_bystringNocreated_atソート項目:created_at または triggered_at。
orderstringNodescソート方向:asc または desc。

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/schedule_runs?identity_id=idn_019eabc123&sort_by=triggered_at&order=desc&limit=20' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK
{
  "data": [
    {
      "id": "srun_019f00112233445566778899aabbccdd",
      "source": "tool",
      "source_session_id": "sess_origin",
      "schedule_id": "sched_019f00112233445566778899aabbccdd",
      "identity_id": "idn_019eabc123",
      "template_id": "tmpl_support",
      "session_id": "sess_019ec55a68b37e1e8d660691af161ab4",
      "status": "completed",
      "trigger_context": {
        "type": "schedule",
        "scheduled_at": "2026-06-22T01:00:00Z"
      },
      "result_payload": "Today's technology highlights: ...",
      "push_sink": "im_channel",
      "push_status": "succeeded",
      "push_finished_at": "2026-06-22T01:00:21Z",
      "attempt": 2,
      "initial_events_version": 1,
      "triggered_at": "2026-06-22T01:00:00Z",
      "started_at": "2026-06-22T01:00:03Z",
      "completed_at": "2026-06-22T01:00:20Z",
      "duration_ms": 17000,
      "created_at": "2026-06-22T01:00:00Z"
    }
  ],
  "first_id": "srun_019f00112233445566778899aabbccdd",
  "last_id": "srun_019f00112233445566778899aabbccdd",
  "has_more": false
}

Response fields

FieldTypeDescription
dataSchedule Run オブジェクトの配列現在のページのレコード。
first_idstring|nullこのページの最初の実行の ID。
last_idstring|nullこのページの最後の実行の ID。
has_morebooleanさらにレコードが残っているかどうか。

Errors

HTTPTypeCode発生条件
400invalid_request_errorinvalid_identityidentity_id が未指定または空です。
400invalid_request_errorinvalid_requeststatus、trigger_type、sort_by、order が不正、after_id と before_id が同時に指定されている、または identity_id、schedule_id、カーソルなどの文字列に未対応の制御文字が含まれています。
400invalid_request_errorinvalid_has_errorhas_error を boolean として解析できません。
400invalid_request_errorinvalid_limitlimit が 1~100 の範囲外、または整数ではありません。
401authentication_error-PAT または SAT が無効または期限切れです。
403permission_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 とは独立しています。