Forward テンプレートをアーカイブします。
POST /api/v1/forward/templates/{template_id}/archive
履歴レコードを削除せずに、テンプレートをアーカイブします。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Idempotency-Key | No | 安全でないリクエストに対する任意の冪等性キー。 |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Forward の Template ID。 |
Example request
Example response
HTTP 200 OK
Response fields
status が archived に設定された、アーカイブ済みの Template オブジェクトを返します。
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT または SAT が無効または期限切れ。 |
| 404 | not_found_error | テンプレートが存在しない、または呼び出し元に表示されない。 |
| 409 | conflict_error | テンプレートの状態がアーカイブを許可していない。 |
| 401 | authentication_error | authentication_required |
Notes
- アーカイブはソフトなライフサイクル状態です。
- アーカイブ済みのテンプレートは、ステータスで明示的に要求しない限り一覧結果から除外されます。