コンテンツにスキップ

削除



POST /api/v1/notification_schedule/delete

概要

現在のワークスペースの通知スケジュールとそのスケジュール履歴を一括で論理削除します。

呼び出し前の確認と使用手順

まずスケジュール一覧で削除対象の UUID を確認し、削除前に通知ポリシー一覧の参照を調整して、削除済みのスケジュールへの依存を避けてください。明示的な UUID 文字列の配列を渡します。空の配列や一致するレコードがない場合でも true を返すことがあります。成功すると当日のオンコールキャッシュがクリアされます。繰り返し呼び出しても、利用可能なスケジュールが存在することを意味するわけではありません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
notificationScheduleUUIDs[*] string 単一スケジュールの UUID 文字列。
例: nsche_example
取得または入力方法: スケジュール一覧から単一の uuid をコピーします。
notificationScheduleUUIDs array Y 削除対象の UUID 配列。現在のワークスペースにのみ適用されます。
null 許可: False
例: ["nsche_example"]
取得または入力方法: スケジュール一覧の content.data[].uuid から削除するスケジュールを選択します。

パラメータ補足説明

true の返却から、渡したすべての UUID が元々存在していたと推測することはできません。削除は通知ポリシーの自動解除を保証するものではないため、事前に参照を確認してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/notification_schedule/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"notificationScheduleUUIDs":["nsche_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 オブジェクトを送信してください。
500 ft.InternalServerError 削除処理、履歴設定の読み取り、オンコールキャッシュのクリア、または監査の異常 内部エラー まず一覧で対象スケジュールがまだ存在するか確認してから再試行を判断してください。traceId と対象 UUID を保持してください。

フィードバック

このページは役に立ちましたか?