メインコンテンツへスキップ
GET /api/v1/forward/schedule_runs/{run_id} 単一の Schedule Run 実行レコードを返します。所有権の追加制約として identity_id を指定できます。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

Path parameters

ParameterTypeRequiredDescription
run_idstringYesSchedule Run ID。

Query parameters

ParameterTypeRequiredDefaultDescription
identity_idstringNo-所有権の追加制約(任意)。

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/schedule_runs/srun_019f00112233445566778899aabbccdd?identity_id=idn_019eabc123' \
  -H "Authorization: Bearer $QODER_PAT"

Example response

HTTP 200 OK
{
  "id": "srun_019f00112233445566778899aabbccdd",
  "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"
  },
  "error": null,
  "error_message": null,
  "result_payload": "Today's technology highlights: ...",
  "push_sink": "im_channel",
  "push_status": "succeeded",
  "push_finished_at": "2026-06-22T01:00:21Z",
  "attempt": 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"
}

Response fields

FieldTypeDescription
idstringSchedule Run ID。
schedule_idstring親 Schedule ID。
identity_idstringForward Identity ID。
template_idstringForward Template ID。
session_idstring|nullこの実行のために作成または再利用された Session。
statusstringpendingrunningcompletedfailed、または skipped
trigger_contextobjectトリガーソース。typeschedule または manual
errorobject|null失敗またはスキップされた実行の構造化エラー。
result_payloadstring|nullメインのテキスト結果。
error_messagestring|null人間が読めるエラーメッセージ。構造化された詳細は error に残ります。
push_sinkstring|nullIM 配信に使用される sink タイプ。配信が構成されていない場合は null
push_statusstringpendingsucceededfailed、または skipped
push_finished_atstring|nullIM 配信の完了時刻。
attemptinteger試行番号。現在は 1
triggered_atstringトリガー時刻。
started_atstring|null実行の開始時刻。
completed_atstring|null実行の終了時刻。
duration_msinteger|null実行時間(ミリ秒)。
created_atstringレコードの作成時刻。

Trigger context

typeDescription
schedulecrononceinterval などの Schedule の trigger_policy から自動的にトリガーされます。自動トリガーには scheduled_at が含まれます。
manualPOST /api/v1/forward/schedules/{schedule_id}/run によって手動でトリガーされます。

Run error

error オブジェクトは構造化された失敗またはスキップの理由を説明します。statusfailed または skipped の場合に返されることがあり、statuscompleted の場合は null です。
error.typeDescription
concurrency_limit_reachedSchedule が execution.max_concurrent_runs に達しました。このトリガーは記録されましたが実行されませんでした。
session_creation_failedForward が実行 Session の作成またはバインドに失敗しました。
execution_failedTemplate の実行が失敗しました。

Errors

HTTPTypeCodeTrigger
401authentication_errorauthentication_requiredPAT が無効または期限切れです。
404not_found_errorschedule_run_not_found実行が存在しない、テナントをまたいでいる、または identity_id 制約を満たしません。

Notes

  • error.type=concurrency_limit_reached は、max_concurrent_runs により実行が記録されたもののスキップされたことを意味します。
  • status が終了状態に入るまで、このエンドポイントをポーリングしてください。

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

スケジュールを取得する