1 つの Schedule Run を ID で取得します。
GET /api/v1/forward/schedule_runs/{run_id}
単一の Schedule Run 実行レコードを返します。所有権の追加制約として identity_id を指定できます。 この Run で選択された入力を確認するには、include_initial_events=true を指定します。
この API は PAT または管理者 SAT のみを許可します。Identity-bound SAT は、自身の identity_id を指定しても呼び出せません。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または管理者 SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
run_id | string | Yes | Schedule Run ID。 |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identity_id | string | No | - | 所有権の追加制約(任意)。 |
include_initial_events | boolean | No | false | true の場合、現在の実行試行にバインドされた入力スナップショットを取得可能なときに返します。 |
Example request
Example response
HTTP 200 OK
Response fields
完全な Schedule Run オブジェクトを返します。トリガーコンテキストとエラータイプも共通のデータ構造で定義されています。
入力スナップショットの取得
initial_events が追加されます。以下はレスポンスの抜粋です。
initial_eventsは Run の現在または最終のattemptにバインドされた入力で、initial_events_versionに対応します。現在の Schedule 設定ではなく、過去の各試行の入力一覧も提供しません。- 未バインド、過去の記録を確認できない場合、バインドが無効な場合は
initial_eventsを省略します。null、空配列、現在の Schedule 入力で代替しません。 - スナップショットは選択済みの入力を示すもので、ランタイムでの受信や実行成功を保証しません。
- パラメーターの省略、
false、空の値では既定のレスポンスを維持します。Run 一覧、手動実行のレスポンス、Webhook には入力全文を含めません。
Errors
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 400 | invalid_request_error | invalid_include_initial_events | include_initial_events が有効な boolean 値ではありません。 |
| 404 | not_found_error | schedule_run_not_found | Run が存在しない、現在の owner に属していない、または identity_id の制約を満たしていません。 |
| 401 | authentication_error | - | PAT または SAT が無効または期限切れです。 |
| 403 | permission_error | - | Identity-bound SAT が PAT または管理者 SAT のみを許可する API を呼び出しています。message は admin service account token required で、レスポンスに error.code は含まれません。 |
Notes
error.type=concurrency_limit_reachedは、max_concurrent_runsにより実行が記録されたもののスキップされたことを意味します。statusが終了状態に入るまで、このエンドポイントをポーリングしてください。