作成¶
POST /api/v1/notice/date/add
概要¶
アラートポリシーから参照されるカスタム通知日付セットを作成します。
呼び出し前の準備と使用手順¶
name および任意の noticeDates を送信して日付セットを作成します。配列を省略するか [] を指定すると空のセットを作成できます。実際の通知が必要な場合は、事前に有効な業務日付を準備してください。各設定は最大 366 項目で、重複した日付はそのまま保存され、件数制限にもカウントされます。サーバー側では YYYY/MM/DD のテキスト形式のみを検証します。2026/02/30 のような存在しない日付も保存される可能性があるため、クライアント側で実際のカレンダーに基づいて検証する必要があります。本リソースは日付セットのみを保存し、当日の開始時刻、継続時間、タイムゾーンは含みません。使用時はアラートポリシーの alertOpt.alertTarget[].customDateUUIDs で本リソースの UUID を参照し、customStartTime/customDuration を併せて設定します。具体的なルールはアラートポリシーのパラメータページを参照してください。現在、アラート実行時のタイムゾーン読み取りには既知の制限があるため、アラートポリシーページの説明に従って実際のタイムゾーンを確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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/add' \
-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 または null | レコード番号。保存前にレスポンスを構築する作成時は null になる可能性があります。操作には 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": null,
"uuid": "ndate_example",
"workspaceUUID": "wksp_example",
"name": "本番メンテナンス日",
"dates": [
"2026/11/20",
"2026/11/27"
],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"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 オブジェクトを送信してください。 |
| 400 | ft.NoticeDateNameRepeat | 現在のワークスペースに同名の未削除の日付設定が存在 | カスタム日付設定の名前が重複しています | 別の名前を選択してください。タイムアウトした場合は、まず作成済みかどうかを確認してください。 |
| 400 | ft.InvalidNoticeDate | noticeDates 内の日付文字列の形式が YYYY/MM/DD に準拠していない | 無効な日付形式 | 4桁の年、2桁の月/日、および半角スラッシュを使用し、カレンダー上の有効性を自身で確認してください。 |
| 406 | ft.CountExceedLimit | noticeDates 配列が 366 項目を超過 | {} の数量が {} の最大制限を超過 | 各設定を 366 項目以内に収め、不要な重複日付を先に除去してください。 |
| 500 | ft.InternalServerError | 日付配列の要素が文字列でない、または保存/キャッシュ処理などの内部的な失敗 | 内部エラー | パラメータ表に従って型と名前の長さを修正してください。まず現在保存済みの設定を確認してから再試行を判断し、失敗が続く場合は traceId を提供してください。 |