Forward Session 内の idle 状態の child Thread をアーカイブします。
POST /api/v1/forward/sessions/{session_id}/threads/{thread_id}/archive
アーカイブできるのは role=child かつ status=idle の Thread だけです。coordinator Thread はアーカイブできません。
リクエストパラメーター
| 場所 | パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|---|
| Header | Authorization | string | はい | Bearer <PAT または SAT> |
| Header | Idempotency-Key | string | いいえ | 1 回の論理的なアーカイブ試行を識別します。新しい試行ごとに一意の値を使用してください。 |
| Path | session_id | string | はい | sess_ プレフィックス付きの Session ID。 |
| Path | thread_id | string | はい | sthr_ プレフィックス付きの Thread ID。 |
リクエスト例
レスポンス例
HTTP 200 OK が返されます。レスポンスは Thread オブジェクトです。
エラー
| HTTP | Type | Code | 条件 |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT または SAT が無効または期限切れです。 |
| 404 | not_found | session_not_found | Session が存在しないか、呼び出し元から参照できません。 |
| 404 | not_found_error | thread_not_found | Thread が存在しないか、その Session に属していません。 |
| 409 | conflict_error | coordinator_thread_not_archivable | coordinator Thread をアーカイブしようとしました。 |
| 409 | conflict_error | thread_not_idle | child Thread が現在 idle ではありません。 |
| 502 | api_error | runtime_unavailable | ランタイムサービスが利用できないか、競合後の状態照合に失敗しました。 |
注記
- 同じ
Idempotency-Keyでは、キャッシュ済みの非 5xx レスポンスが再生されます。409 thread_not_idleの後に状態が変わって再試行する場合は、新しい key を使用してください。 - 不明確な
502 runtime_unavailableは同じ key で再試行できます。 - 最終状態は Thread 取得エンドポイントで確認し、
session.thread_status_terminatedEvent だけに依存しないでください。