コンテンツにスキップ

一覧取得



GET /api/v1/notice/date/list

概要

現在のワークスペースのカスタム通知日付設定をページネーションで取得します。

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

デフォルトは pageIndex=1、pageSize=20 で、レコード番号の降順です。content.data 配列とトップレベルの pageInfo を読み取ります。uuid はアラートポリシーから参照するために保存します。日付フィールドはレスポンスでは dates という名前です。このリソースは日付の集合のみを保存し、当日の開始時刻、継続時間、タイムゾーンは含みません。使用時は、アラートポリシーの alertOpt.alertTarget[].customDateUUIDs でこのリソースの UUID を参照し、customStartTime/customDuration を併せて設定します。具体的なルールはアラートポリシーのパラメータページを参照してください。現在、アラート実行時のタイムゾーンの読み取りには既知の制限があるため、アラートポリシーページの説明に従って実際のタイムゾーンを確認してください。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 型 必須 説明
pageIndex integer ページ番号。デフォルトは 1、最小値は 1。
null 許可: False
$minValue: 1
例: 1
取得または入力方法: 1 からページごとに増やし、検索条件は変更しないでください。
pageSize integer 1ページあたりの件数。デフォルトは 20、上限は 10000。
null 許可: False
$maxValue: 10000
$minValue: 1
例: 20
取得または入力方法: 必要に応じて 1~10000 を指定します。レスポンスサイズを抑えるため、適切なページサイズを使用することを推奨します。
search string 名前のあいまい検索(任意)。
null 許可: True
例: 维护
取得または入力方法: 日付設定名の一部を入力します。省略または空白の場合、フィルタリングしません。

パラメータの補足説明

日付の集合自体は通知を発生させません。アラートポリシーの作成 v2 でターゲットとカスタム日付ウィンドウを設定する必要があります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/notice/date/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20

レスポンス

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

フィールド 型 説明
content.data array<object> 現在のページの設定。結果がない場合は []。
content.data[].id integer 保存済み日付設定のレコード番号。操作には uuid を使用します。
content.data[].uuid string 日付設定の UUID。アラートポリシーの customDateUUIDs から参照されます。
content.data[].workspaceUUID string 所属ワークスペースの UUID。
content.data[].name string 設定名。
content.data[].dates array<string> 保存された日付の配列。リクエストのフィールド名は noticeDates、レスポンスのフィールド名は dates です。
content.data[].dates[] string 個々の YYYY/MM/DD 形式の日付文字列。
content.data[].status integer レコードの状態。0 は正常、3 は削除済み。
content.data[].creator string 作成者の識別子。
content.data[].updator string 最終更新者の識別子。未更新の場合は空文字列。
content.data[].createAt integer 作成日時(Unix 秒)。
content.data[].updateAt integer 更新日時(Unix 秒)。未更新の場合は -1。
content.data[].deleteAt integer 削除日時(Unix 秒)。未削除の場合は -1。
content.declaration object または null ワークスペースの共通宣言。
pageInfo object トップレベルのページネーション。
pageInfo.pageIndex integer ページ番号。
pageInfo.pageSize integer ページサイズ。
pageInfo.count integer 現在のページの実際の件数。
pageInfo.totalCount integer 一致する設定の総数。
{
  "code": 200,
  "content": {
    "data": [
      {
        "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",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "count": 1,
    "totalCount": 1
  }
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している場合 パラメータの解析に失敗しました パラメータの位置、フィールド名、型、値を確認してください。
500 ft.InternalServerError 日付設定の読み取りに失敗しました 内部エラー 後で再試行し、失敗が続く場合は traceId を提供してください。

フィードバック

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