コンテンツにスキップ

変更



POST /api/v1/notice/date/{notice_date_uuid}/modify

概要

カスタム通知日付設定を変更し、日付セットを全体として置き換えます。

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

変更時は name を必ず送信し、noticeDates は完全な対象セットで置き換えます。noticeDates を省略すると元のセットはクリアされるため、元の日付を保持する場合は先に詳細を取得してから完全な形で送信する必要があります。変更時には現在のワークスペースのアラートポリシー実行キャッシュがクリアされ、この日付セットを使用するウィンドウはその後新しい値で更新されます。各設定の上限は 366 項目で、重複した日付もそのまま保存され、件数制限の対象になります。サーバー側では YYYY/MM/DD のテキスト形式のみを検証します。たとえば 2026/02/30 のような存在しない日付も保存される可能性があるため、クライアント側で実際のカレンダーに基づく検証を必ず行う必要があります。このリソースは日付セットのみを保存し、当日の開始時刻、継続時間、タイムゾーンは含みません。使用時は、アラートポリシーの alertOpt.alertTarget[].customDateUUIDs でこのリソースの UUID を参照し、customStartTime/customDuration を併せて設定します。具体的なルールについては、アラートポリシーのパラメータページを参照してください。現在、アラート実行時のタイムゾーン読み取りには既知の制限があるため、アラートポリシーページの説明に従って実際のタイムゾーンを確認してください。

パスパラメータ

パラメータ名 型 必須 説明
notice_date_uuid string Y このワークスペースのカスタム通知日付設定 UUID で、ndate_ で始まります。日付文字列やアラートポリシー UUID ではありません。
空文字列を許可: False
例: ndate_example
取得方法または入力方法: カスタム通知日付一覧 の content.data[].uuid、または作成レスポンスの content.uuid から取得します。

リクエストヘッダー

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

リクエストボディパラメータ

パラメータ名 型 必須 説明
noticeDates[*] string 単一の日付文字列(YYYY/MM/DD)。サーバー側は形式の正規表現のみを検査し、閏年や月の日数などを完全には検証しないため、保存成功だけで日付が実在すると判断できません。
例: 2026/11/20
取得方法または入力方法: 業務カレンダーから 4 桁の年、2 桁の月、2 桁の日を生成します(例: 2026/11/20)。クライアント側で実際のカレンダー上の有効性を確認する必要があります。
name string Y 必須の名前です。宣言上の最大長は 256 文字ですが、現在の保存フィールドの容量はより短いため、保存失敗を減らすには 64 文字以下を推奨します。
null を許可: False
最大長: 256
例: 生产维护日
取得方法または入力方法: カスタム通知日付一覧 でこのワークスペースの既存名称を確認したうえで、任意の名前を付けます。
noticeDates array 任意指定可能な完全な日付文字列の配列で、最大 366 項目(重複項目もカウントされます)。作成時に省略すると [] が保存され、変更時に省略するか [] を指定すると元の日付セットがクリアされます。
null を許可: False
例: ["2026/11/20", "2026/11/27"]
取得方法または入力方法: 業務上の保守/通知カレンダーに従って実在する日付を選択し、YYYY/MM/DD 文字列で入力します。タイムスタンプへの変換は不要です。

パラメータ補足説明

日付設定ではタイムゾーン、開始時刻、継続秒数を指定しません。これらはこの設定を参照するアラートポリシーのアクションによって制御されます。保存に成功しても通知はすぐには送信されません。リクエストが失敗した場合は、まず保存済みかどうかを確認してから再試行を判断してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/notice/date/ndate_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"生产维护日","noticeDates":["2026/11/20","2026/11/27"]}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content.id integer 保存された日付設定レコードの番号。操作には uuid を使用します。
content.uuid string 日付設定の UUID。アラートポリシーの customDateUUIDs から参照されます。
content.workspaceUUID string 所属するワークスペースの UUID。
content.name string 設定名。
content.dates array<string> 保存された日付配列。リクエスト時のフィールド名は noticeDates、レスポンス時のフィールド名は dates です。
content.dates[] string 単一の YYYY/MM/DD 日付文字列。
content.status integer レコードのステータス。0 は正常、3 は削除済み。
content.creator string 作成者の識別子。
content.updator string 最終更新者の識別子。未更新の場合は空文字列。
content.createAt integer 作成日時(Unix 秒)。
content.updateAt integer 更新日時(Unix 秒)。未更新の場合は -1。
content.deleteAt integer 削除日時(Unix 秒)。未削除の場合は -1。
content.declaration object または null ワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "id": 42,
    "uuid": "ndate_example",
    "workspaceUUID": "wksp_example",
    "name": "生产维护日",
    "dates": [
      "2026/11/20",
      "2026/11/27"
    ],
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785430800,
    "updateAt": 1785430860,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.ObjectNotExists 日付設定が存在しない、削除済み、または現在のワークスペースに属していない 指定されたオブジェクトが存在しません カスタム通知日付一覧 から有効な uuid を再取得します。
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している パラメータの解析に失敗しました パラメータの位置、フィールド名、型、値を確認します。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正します。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトではない 一部の json ファイル形式が正しくありません 単一の JSON オブジェクトを送信します。
400 ft.NoticeDateNameRepeat 現在のワークスペースに同名の未削除の日付設定が存在する カスタム日付設定の名前が重複しています 別の名前を選択します。タイムアウトした場合は、まず作成済みかどうかを確認します。
400 ft.InvalidNoticeDate noticeDates 内の日付文字列形式が YYYY/MM/DD に準拠していない 無効な日付形式 4 桁の年、2 桁の月/日、および半角スラッシュを使用し、カレンダー上の有効性を自身で確認してください。
406 ft.CountExceedLimit noticeDates 配列が 366 項目を超えている {} の数が最大制限 {} を超えています 各設定を 366 項目以内に抑え、不要な重複日付を先に削除します。
500 ft.InternalServerError 日付配列の要素が文字列ではない、または保存/キャッシュ処理などの内部障害 内部エラー パラメータ表に従って型と名前の長さを修正します。まず現在保存されている設定を確認してから再試行を判断し、失敗が続く場合は traceId を提供してください。

フィードバック

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