カスタムレベルの削除¶
POST /api/v1/issue-level/delete
概要¶
現在のワークスペースのカスタムレベルを一括削除します。
呼び出し前と使用手順¶
本ワークスペースのカスタムレベル UUID のみを渡します。システムデフォルトの system_level_ プレフィックスが付くレベルは削除できません。送信前に、引き続きこれらのレベルを必要とする Issue または関連ルールを調整してください。この API は過去の Issue の level を自動移行しません。見つからないカスタムレベル識別子は変更を発生させない場合があり、true が返されてもすべての UUID が存在することを示すものではありません。空の配列を送信しないでください。現在、空配列のパスは監査処理で内部エラーを返す可能性があります。操作には現在の API Key が属するワークスペースが使用されます。同じワークスペースからリソース識別子を取得してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| uuids[*] | string | 単一のレベル UUID。 例: issl_example取得または入力方法: 本ワークスペースの issl_ で始まるカスタムレベル UUID を使用します。 |
|
| uuids | array | Y | 削除対象のカスタムレベル UUID 配列。必須。システムデフォルトレベルを含みません。 null の許可: False 例: ["issl_example"]取得または入力方法: カスタムレベルの作成レスポンスで保存された content.uuid、または有効なレベル一覧に表示される項目から取得します。削除前に、今後使用しないことを確認してください。少なくとも 1 つの実在する UUID を送信してください。 |
パラメータの補足説明¶
削除すると、該当するレベルは本ワークスペースの有効なレベルとして使用されなくなります。過去の Issue には古い UUID および人間が読める表示情報が引き続き保持される可能性があります。この操作はレベル設定を削除しますが、Issue は削除しません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue-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 ファイルの形式エラー | JSON オブジェクトを送信してください。 |
| 406 | ft.NotAllowDeleteDefaultIssueLevel | uuids に system_level_ プレフィックスが付くデフォルトレベルが含まれている | ワークスペースのデフォルトレベル設定情報は削除できません | デフォルトレベルを除外してください。デフォルトレベルを無効化する必要がある場合は、デフォルトレベルのスイッチを使用してください。 |
| 500 | ft.InternalServerError | レベルの保存、設定の保存、監査、その他の内部処理に失敗 | 内部エラー | まず現在のレベルまたは設定を読み取って結果を確認し、その後再試行を判断してください。失敗が続く場合は traceId を提供してください。 |