カスタムレベル 削除¶
POST /api/v1/incidents/level/delete
概要¶
現在のワークスペースのカスタムインシデントレベルを一括削除します。
呼び出し前の準備と使用手順¶
Keyにはincidents.incidentsLevelManageが必要で、現在のKeyが属するワークスペースのみが対象です。このモジュールはIssueレベルのインターフェースと基盤となるレベルおよびデフォルトレベルの設定を共有しているため、変更はインシデント/Issueのレベル選択にも同時に影響する可能性があります。本モジュールだけに独立したコピーが作成されるわけではありません。バックエンドでグローバルレベルが有効になっている場合、実際に有効なレベル選択はグローバル設定が優先して決定することがあります。本ワークスペースの管理リストには引き続きデフォルトとワークスペースのカスタム項目のみが表示され、バックエンドのグローバルレベルは含まれません。管理者は有効になる範囲を確認したうえで変更し、管理リストのすべての項目を利用可能なレベルとして扱わないでください。
uuidsは必須の配列で、[]の場合は直接trueで成功します。いずれかの項目がsystem_level_で始まる場合、バッチ全体が拒否されます。それ以外は本ワークスペースの未削除の一致項目のみを削除し、不明なUUID、他のワークスペースのUUID、削除済みのUUIDは通知なく無視されます。削除件数や項目ごとの結果は返されず、trueは各項目が存在したことを意味しません。
これはレベルの設定のソフト削除であり、インシデント/Issueを削除したり、その履歴level値をクリアしたりするものではありません。また、モニター/インシデント/エスカレーション設定の参照を自動的に移行することもありません。現在、「まだ使用されているため削除不可」や「カスタムレベルを少なくとも1つ保持する」といった実行時の保護はありません。デフォルトを無効化した後でも、すべてのカスタム項目を削除できます。削除する前に参照を洗い出して調整し、必要なレベルを保持してください。削除後はレベルリストと業務上の表示を確認してください。失敗した場合は、まず現在の状態を読み戻してから再試行してください。500エラーだけをもって未削除と判断しないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースのOpenAPI認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースのAPI Key管理から、この操作権限を持つOpenAPI Keyを取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| uuids[*] | string | 単一のカスタムレベルUUID文字列。system_level_プレフィックスは不可。 例: issl_example取得または入力方法: uuidsの取得元と同じです。 |
|
| uuids | array | Y | 必須の配列。[]の場合は操作なしでtrue。本ワークスペースに一致するカスタム項目のみを削除し、件数は返しません。デフォルトレベルのプレフィックスを含む場合はバッチ全体が拒否されます。 null許容: False 例: ["issl_example"]取得または入力方法: インシデントレベル一覧からisDefault=falseのuuidを取得し、事前に参照を洗い出してください。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/level/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"uuids":["issl_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 常にtrue。一致するレコードが存在しない可能性があります。削除件数はありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエストJSONの構文が無効 | リクエストJSONの形式エラー | content.reason、line、columnに従ってJSONを修正してください。 |
| 400 | ft.JsonFormatError | JSONのトップレベルがオブジェクトでない | 一部のjsonファイルの形式エラー | uuids配列のオブジェクトを送信してください。 |
| 406 | ft.NotAllowDeleteDefaultIssueLevel | uuidsにsystem_level_プレフィックスの値が含まれる | ワークスペースのデフォルトレベル設定情報は削除できません | デフォルトレベルはconfig_setで有効/無効を切り替えるもので、削除できません。カスタム項目はリストから絞り込んでください。 |
| 500 | ft.InternalServerError | データベース、設定/ID形式、または未処理のシステム例外 | 内部エラー | 読み取りはバックオフして再試行できます。書き込みはまず設定/レベルリストを読み戻して保存済みか確認してから、再試行するか判断してください。 |