Skip to main content

スケジュールを実行する

1 つの Schedule Run を手動でトリガーします。

POST /api/v1/forward/schedules/{schedule_id}/run Schedule のトリガーポリシーを変更せずに、Schedule Run を即座に作成します。このエンドポイントは、実行の完了時ではなく Run レコードの作成時に応答を返します。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT または SAT>
Content-TypeNoボディを送信する場合は application/json。
Idempotency-KeyNo安全でないリクエスト向けの任意のべき等キー。

Path parameters

ParameterTypeRequiredDescription
schedule_idstringYesForward Schedule ID。

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd/run' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK
{
  "id": "srun_019f00112233445566778899aabbccdd",
  "source": "tool",
  "source_session_id": "sess_origin",
  "schedule_id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "status": "pending",
  "trigger_context": {
    "type": "manual"
  },
  "push_status": "skipped",
  "push_finished_at": "2026-06-22T01:00:21Z",
  "attempt": 1,
  "triggered_at": "2026-06-22T12:00:00Z",
  "created_at": "2026-06-22T12:00:00Z"
}

Response fields

作成された Schedule Run オブジェクトを返します。 新しく作成された Run は attempt=1 から開始します。Schedule が execution.max_attempts=2 に設定されている場合、サーバーは最初の実行失敗後に自動的に再試行する可能性があります。実際に再試行が行われたかは Get Schedule Run または List Schedule Runs で返される attempt で確認できます。

Errors

HTTPTypeCode発生条件
400invalid_request_errorinvalid_identitySchedule が属する Identity が無効化されているため、新しい実行を開始できません。
404not_found_errorschedule_not_foundSchedule が存在しないか、現在の owner に属していません。
409invalid_request_errorschedule_archivedSchedule はアーカイブ済みです。
409invalid_request_errorschedule_not_activeSchedule は一時停止中です。
401authentication_error-PAT または SAT が無効または期限切れです。
403permission_erroridentity_mismatchIdentity-bound SAT が、バインドされた Identity 以外の Schedule を要求または操作しています。

Notes

  • 新規 Run は入力が選択されるまで initial_events_version を省略します。選択後は Run の照会レスポンスで確認できます。入力バージョンを参照してください。
  • 各実行試行は Schedule の resources を選択し、タスク送信前に現在の Template / Identity Config の継承ファイルとマージして適用します。この API に 1 回限りの resources 上書きパラメーターはありません。ファイルはSchedule の更新で変更してください。適用規則はファイルリソースを参照してください。
  • Schedule が execution.max_concurrent_runs に達している場合でも、Forward は status=skipped および error.type=concurrency_limit_reached の Run を作成します。
  • status が completed、failed、または skipped になるまで Get Schedule Run をポーリングしてください。