コンテンツにスキップ

取得



GET /api/v1/dashboard/carousel/{carousel_uuid}/get

概要

指定したカルーセル設定とそのダッシュボード名を読み取ります。

呼び出し前の準備と使用手順

カルーセル一覧からカルーセル UUID を取得します。読み取り時に無効なダッシュボード参照がクリーンアップされます。履歴に無効な参照がある場合、今回の dashboardUUIDs には古い値が残る可能性があります。dashboardInfo を解析済みの有効なダッシュボードとして扱い、再度読み取るとクリーンアップ後のリストを確認できます。

ルートパラメータ

パラメータ名 型 必須 説明
carousel_uuid string Y カルーセル設定 UUID。
例: csel_example
取得または入力方法: 同じワークスペースおよび呼び出し元の下で、カルーセル一覧の content[].uuid からコピーします。作成レスポンスの content.uuid を使用することもできます。

リクエストヘッダー

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

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/dashboard/carousel/csel_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content.id integer カルーセルレコードの内部番号。
content.uuid string カルーセル設定 UUID。詳細、変更、削除で使用します。
content.accountUUID string カルーセルが属する呼び出し元の ID。
content.workspaceUUID string カルーセルが属するワークスペースの UUID。
content.name string カルーセル名。
content.intervalTime string 保存済みのカルーセル間隔文字列。
content.dashboardUUIDs array<string> 保存済みのダッシュボード UUID。カルーセルの表示順に並びます。
content.status integer レコードのステータス。
content.createAt number 作成時刻(Unix 秒)。
content.updateAt number 最終更新時刻(Unix 秒)。更新がない場合は -1。
content.deleteAt number 削除時刻(Unix 秒)。未削除の場合は -1。
content.creator string 作成者の ID。
content.updator string 最終更新者の ID。更新がない場合は空文字列。
content.declaration object または null ワークスペースの共通宣言。
content.dashboardInfo array<object> カルーセルの表示順に並びます。各項目は単一キーのマッピングで、キーはダッシュボード UUID、値はダッシュボード名です。
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "csel_example",
    "accountUUID": "wsak_example",
    "workspaceUUID": "wksp_example",
    "name": "生产巡检轮播",
    "intervalTime": "30s",
    "dashboardUUIDs": [
      "dsbd_example"
    ],
    "status": 0,
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "creator": "wsak_example",
    "updator": "",
    "declaration": {},
    "dashboardInfo": [
      {
        "dsbd_example": "生产巡检"
      }
    ]
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.DashboardCarouselObjectNotExist 設定が削除済み、存在しない、または現在の呼び出し元およびワークスペースに属していない このカルーセルオブジェクトは存在しません 同じ Key を使用してカルーセル一覧から設定がまだ存在することを確認し、実際の UUID を使用してください。

フィードバック

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