削除¶
POST /api/v1/issue/notification_policy/delete
概要¶
通知ポリシーを一括削除し、関連するチャンネル、スケジュールの関連付け、およびエスカレーショントリガー設定をクリーンアップします。
呼び出し前と使用手順¶
通知ポリシーリスト から削除するポリシーの UUID を取得し、チャンネルがこれらのポリシーに依存していないことを確認してから配列を送信します。この操作ではポリシー設定と関連付けが削除されますが、スケジュール、チャンネル、Issue、通知先自体は削除されません。一致するレコードがない場合や空の配列の場合も true を返すことがあります。項目ごとの削除結果は提供されません。削除後、以降の通知ではこのポリシーは使用されませんが、投入済みの非同期タスクや既存のメッセージが取り消されることは保証されません。ポリシー本体、関連付け、エスカレーショントリガー設定は段階的に保存されます。失敗またはタイムアウト後は、まず詳細を取得して既存の変更を確認してから、再試行するかどうかを決定してください。
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issueNotificationPolicyUUIDs[*] | string | 単一の通知ポリシー UUID。 例: inpy_example取得または入力方法: 通知ポリシーリスト から単一の UUID をコピーします。 |
|
| issueNotificationPolicyUUIDs | array | Y | 削除対象ポリシーの UUID 配列。必須。[] の場合はポリシーを削除しません。 null を許可: False 例: ["inpy_example"]取得または入力方法: 通知ポリシーリスト の content.data[].uuid から同一ワークスペースのポリシー UUID を取得します。 |
パラメーター補足説明¶
一括リクエストは、現在のワークスペース内で一致するポリシーのみを操作します。一時的に無効化する必要がある場合は、コンソールで操作できます。これら5つの公開APIには、個別の有効化/無効化メソッドはありません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue/notification_policy/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"issueNotificationPolicyUUIDs":["inpy_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除処理が完了した場合は true。一致するポリシーがない場合も 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 オブジェクトを送信してください。 |
| 500 | ft.InternalServerError | ポリシー、関連付け、またはエスカレーション設定のクリーンアップに失敗しました | 内部エラー | まずポリシーと関連付けの状態を照会してから再試行するかどうかを決定してください。失敗が続く場合は traceId を提供してください。 |