削除¶
POST /api/v1/incidents/schedule/delete
概要¶
インシデントオンコールとその履歴設定を一括でソフト削除します。
呼び出し前の確認と使用手順¶
現在の Key には incidents.incidentsSchedule が必要です。現在のワークスペースで未削除の一致するスケジュールのみが対象です。未知/クロスワークスペース/削除済みの項目は無視され、[] は対象なしでも true となり、項目ごとの結果はありません。一致するデフォルトスケジュールに isDefault=true が含まれる場合は 400 で拒否されます。先にデフォルト項目を確認する必要があり、一括リクエストをデフォルト項目の自動スキップとして扱うことはできません。
ヒットしたスケジュールとその履歴更新レコードをソフト削除しますが、既存のインシデント、通知先、チーム、メンバーは削除しません。このメソッドは一時的な代理オンコールエンティティを併せてクリーンアップしないため、成功をもってすべての代理オンコールデータが物理削除されたと主張することはできません。送信後、インシデントマッチングキューからの削除を1件ずつ配信します。配信に失敗すると 500 となる場合がありますが、すでにソフト削除されています。先に一覧で確認してから再試行してください。削除後にこの公開 API での復元インターフェースはありません。事前に設定をバックアップしてください。再作成すると新しい UUID が生成されます。送信済みの通知は取り消されません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| scheduleUUIDs[*] | string | 1つのスケジュールUUID文字列であり、ポリシー/インシデント/代理オンコールUUIDではありません。子項目の有効性は個別に検証されません。 例: incsch_example取得または入力方法: オンコール一覧の通常管理モードのcontent.data[].uuidからincsch_ UUIDを取得します。 |
|
| scheduleUUIDs | array | Y | 必須UUID配列。[]はヒットなし。現在のワークスペースで未削除の一致項目のみ。デフォルトスケジュールは削除できません。 null を許可: False 例: ["incsch_example"]取得または入力方法: オンコール一覧の通常管理モードのcontent.data[].uuidからincsch_ UUIDを取得します。 |
パラメータ補足説明¶
リクエストは本ページで公開されているパラメータを基準とします。日内の start/end は HH:MM、有効期間と代理オンコール時間は Unix 秒です。完全なフィールド、値の取得元、レスポンス分岐、失敗時の処理については以下を参照してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/schedule/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"scheduleUUIDs":["incsch_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 ファイル形式エラー | scheduleUUIDs 配列オブジェクトを送信します。 |
| 400 | ft.DefaultIncidentScheduleCannotDelete | 一致項目に isDefault=true のデフォルトスケジュールが含まれる | デフォルトのインシデントオンコールは削除できません | デフォルトスケジュールを除外し、先に一覧を確認します。デフォルト設定を強制的に削除することはできません。 |
| 500 | ft.InternalServerError | データベース/タグロックキャッシュ、通知サブ構造、無効なタイムゾーン、コミット後のキュー配信など、未処理の例外 | 内部エラー | まずスケジュール/タグの実際の状態を読み戻します。本体はすでにコミットされている可能性があり、キューが収束していなくても重複作成すべきではありません。traceId を保持して処理し、変更前に完全な設定をバックアップしてください。 |