1 つの Schedule Run を手動でトリガーします。
POST /api/v1/forward/schedules/{schedule_id}/run
Schedule のトリガーポリシーを変更せずに、Schedule Run を即座に作成します。このエンドポイントは、実行の完了時ではなく Run レコードの作成時に応答を返します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Content-Type | No | ボディを送信する場合は application/json。 |
Idempotency-Key | No | 安全でないリクエスト向けの任意のべき等キー。 |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
schedule_id | string | Yes | Forward Schedule ID。 |
Example request
Example response
HTTP 200 OK
Response fields
作成された Schedule Run オブジェクトを返します。
新しく作成された Run は attempt=1 から開始します。Schedule が execution.max_attempts=2 に設定されている場合、サーバーは最初の実行失敗後に自動的に再試行する可能性があります。実際に再試行が行われたかは Get Schedule Run または List Schedule Runs で返される attempt で確認できます。
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT または SAT が無効または期限切れです。 |
| 404 | not_found_error | schedule_not_found | Schedule が存在しません。 |
| 409 | invalid_request_error | schedule_archived | Schedule はアーカイブ済みです。 |
| 409 | invalid_request_error | schedule_not_active | Schedule は一時停止中です。 |
Notes
- Schedule が
execution.max_concurrent_runsに達している場合でも、Forward はstatus=skippedおよびerror.type=concurrency_limit_reachedの Run を作成します。 statusがcompleted、failed、またはskippedになるまで Get Schedule Run をポーリングしてください。