取得¶
GET /api/v1/notice/date/{notice_date_uuid}/get
概要¶
1 つの日付設定の名前と完全な日付セットを読み取ります。
呼び出し前の準備と使用手順¶
カスタム通知日付一覧から uuid を取得してから呼び出します。変更時は content.dates を完全な対象配列として読み取ります。レスポンスの dates フィールドをそのままリクエストパラメータとして扱わないでください。リクエストでは必ず noticeDates を使用する必要があります。このリソースは日付セットのみを保存し、当日の開始時刻、継続時間、タイムゾーンは含みません。使用時は、アラートポリシーの 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 キー管理から、この操作権限を持つ OpenAPI キーを取得します。 |
パラメータ補足説明¶
このインターフェースは保存済みの日付を読み取るものであり、過去の値に対して実際のカレンダー上の妥当性を再検証しません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/notice/date/ndate_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
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": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 日付設定が存在しない、削除済み、または現在のワークスペースに属していない | 指定されたオブジェクトが存在しません | カスタム通知日付一覧から有効な uuid を再取得してください。 |
| 500 | ft.InternalServerError | 日付設定の読み取りに失敗 | 内部エラー | 後で再試行してください。失敗が続く場合は traceId を提供してください。 |