コンテンツにスキップ

拡張情報設定



POST /api/v1/dashboards/{dashboard_uuid}/set_extend

概要

1つのダッシュボードのデフォルトクエリワークスペースと所属サイトを一括で更新します。

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

まず認可ワークスペースリストから認可ワークスペースの UUID と regionCode を取得します。同じ設定では同一サイトのワークスペースを選択します。送信後、ダッシュボード詳細を呼び出して extend を確認できます。上書きされるのは送信した拡張項目のみで、デフォルトクエリワークスペースを変更しつつ targetRegion を省略すると、以前のサイト識別子がクリアされます。データクエリは引き続き実際の認可に従って実行されます。

ルートパラメータ

パラメータ名 型 必須 説明
dashboard_uuid string Y 対象ダッシュボードの UUID。
例: dsbd_example
取得または入力方法: ダッシュボードリストの content.data[].uuid からコピーします。作成結果の content.uuid を使用することもできます。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
defaultTargetWorkspaceUUIDs array Y デフォルトクエリワークスペースの UUID 配列。
null 許可: False
例: ["wksp_example"]
取得または入力方法: 認可ワークスペースリストの対象サイトグループから content[].data[].workspaceUUID をコピーします。必要に応じてデフォルトクエリワークスペースを設定します。[] を渡すとリストをクリアできます。
targetRegion string 対象ワークスペースが所属するサイトの regionCode。
null 許可: False
空文字列許可: False
例: site-example
取得または入力方法: 認可ワークスペースリストから、これらのワークスペースに対応する regionCode を取得します。現在のサイトを使用する場合は省略できます。

パラメータ補足説明

この API はデフォルトクエリ設定のみを保存します。同じダッシュボードを同時に変更する場合は直列に実行してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/set_extend' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"defaultTargetWorkspaceUUIDs":["wksp_example"]}'

レスポンス

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

フィールド 型 説明
content boolean 拡張設定の保存に成功した場合は true。
{
  "code": 200,
  "content": true,
  "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 オブジェクト内に配置してください。
404 ft.NotFoundView 対象ダッシュボードが存在しない、削除済み、または現在のワークスペースにない 指定されたビューが見つかりません 現在のワークスペースのダッシュボードリストから返された UUID を使用してください。
403 ft.ForbiddenDashboardOperation 呼び出し元の識別情報が対象ダッシュボードを操作できない ダッシュボード【{}】の操作権限がありません ダッシュボードの可視範囲、操作権限、および使用している API Key を確認してください。

フィードバック

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