ワークスペース API を使用してダッシュボードを管理する

[アーティクル]
02/07/2025

このチュートリアルでは、Lakeview API と Workspace API を使用してダッシュボードを管理する方法について説明します。各手順には、要求と応答のサンプルと、API ツールとプロパティを一緒に使用する方法に関する説明が含まれています。各ステップは単独で参照できます。すべての手順に従って、完全なワークフローを進めることができます。

注

このワークフローは、ワークスペース API を呼び出して、AI/BI ダッシュボードを汎用ワークスペースオブジェクトとして取得します。 AI/BI ダッシュボードは、以前は Lakeview ダッシュボードと呼ばれるものでした。 Lakeview API はその名前を保持します。

前提条件

Azure Databricks リソースにアクセスするための認証を設定します。認証オプションとセットアップ手順については、「Azure Databricks リソースへのアクセスの承認を参照してください。
アクセスするワークスペース URL が必要です。ワークスペースインスタンス名、URL、IDを参照してください。
Databricks REST API リファレンスに関する知識。

手順 1: ワークスペースディレクトリを探索する

ワークスペースリスト API GET /api/2.0/workspace/list を使用すると、ワークスペースのディレクトリ構造を調べることができます。たとえば、現在のワークスペース内のすべてのファイルとディレクトリの一覧を取得できます。

次の例では、要求の path プロパティは、ユーザーのホームフォルダーに格納 examples_folder という名前のフォルダーを指しています。ユーザー名はパスに指定されています。first.last@example.com。

応答は、フォルダーにテキストファイル、ディレクトリ、AI/BI ダッシュボードが含まれていることを示しています。

GET /api/2.0/workspace/list

Query Parameters:
{
"path": "/Users/first.last@example.com/examples_folder"
}

Response:
{
  "objects": [
    {
      "object_type": "FILE",
      "path": "/Users/first.last@example.com/examples_folder/myfile.txt",
      "created_at": 1706822278103,
      "modified_at": 1706822278103,
      "object_id": 3976707922053539,
      "resource_id": "3976707922053539"
  },
  {
      "object_type": "DIRECTORY",
      "path": "/Users/first.last@example.com/examples_folder/another_folder",
      "object_id": 2514959868792596,
      "resource_id": "2514959868792596"
  },
  {
      "object_type": "DASHBOARD",
      "path": "/Users/first.last@example.com/examples_folder/mydashboard.lvdash.json",
      "object_id": 7944020886653361,
      "resource_id": "01eec14769f616949d7a44244a53ed10"
    }
  ]
}

手順 2: ダッシュボードをエクスポートする

Workspace Export API GET /api/2.0/workspace/export を使用すると、ダッシュボードの内容をファイルとしてエクスポートできます。 AI/BI ダッシュボードファイルには、ダッシュボードのドラフトバージョンが反映されます。次の例の応答は、最小限のダッシュボード定義の内容を示しています。シリアル化の詳細を調べて理解するには、独自のダッシュボードの一部をエクスポートしてみてください。

エクスポートしたファイルをダウンロードする

次の例は、API を使用してダッシュボードファイルをダウンロードする方法を示しています。

この例の "path" プロパティは、ファイルの種類の拡張子 lvdash.json(AI/BI ダッシュボード) で終わります。ワークスペースに表示されるファイル名は、その拡張子の前にあります。この場合は、mydashboardです。

さらに、この要求の "direct_download" プロパティは true に設定されるため、応答はエクスポートされたファイル自体になり、"format" プロパティは "AUTO"に設定されます。

注

応答の pages プロパティに表示される "displayName" プロパティには、ワークスペース内のダッシュボードの表示名は反映されません。

GET /api/2.0/workspace/export

Query parameters:
{
  "path": "/Users/first.last@example.com/examples_folder/mydashboard.lvdash.json",
  "direct_download": true,
  "format": "AUTO"
}

Response:
{
  "pages": [
    {
      "name": "880de22a",
      "displayName": "New Page"
    }
  ]
}

エクスポートされたファイルをエンコードする

次のコードは、"direct_download" プロパティが false に設定されている応答の例を示しています。応答には、base64 でエンコードされた文字列としてコンテンツが含まれています。

GET /api/2.0/workspace/export

Query parameters:
{
    "path": "/Users/first.last@example.com/examples_folder/mydashboard.lvdash.json",
    "direct_download": false
}

Response:
{
    "content": "IORd/DYYsCNElspwM9XBZS/i5Z9dYgW5SkLpKJs48dR5p5KkIW8OmEHU8lx6CZotiCDS9hkppQG=",
    "file_type": "lvdash.json"
}

手順 3: ダッシュボードをインポートする

ワークスペースインポート API POST /api/2.0/workspace/import を使用して、下書きダッシュボードをワークスペースにインポートできます。たとえば、前の例のようにエンコードされたファイルをエクスポートした後、そのダッシュボードを新しいワークスペースにインポートできます。

インポートを AI/BI ダッシュボードとして認識するには、次の 2 つのパラメーターを設定する必要があります。

"format": "AUTO" - この設定により、システムは資産の種類を自動的に検出できます。
"path": ".lvdash.json" で終わるファイルパスを含める必要があります。

重要

これらの設定が正しく構成されていない場合、インポートは成功する可能性がありますが、ダッシュボードは通常のファイルのように扱われます。

次の例は、適切に構成されたインポート要求を示しています。


POST /api/2.0/workspace/import

Request body parameters:
{
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json",
        "content": "IORd/DYYsCNElspwM9XBZS/i5Z9dYgW5SkLpKJs48dR5p5KkIW8OmEHU8lx6CZotiCDS9hkppQG=",
        "format": "AUTO"
}

Response:
{}

手順 4: インポート時に上書きする (省略可能)

同じ API 要求を再実行しようとすると、次のエラーが発生します。

{
        "error_code": "RESOURCE_ALREADY_EXISTS",
        "message": "Path (/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json) already exists."
}

代わりに重複する要求を上書きする場合は、次の例のように、"overwrite" プロパティを true に設定します。


POST /api/2.0/workspace/import

Request body parameters:
{
        "path": /Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json",
        "content": "IORd/DYYsCNElspwM9XBZS/i5Z9dYgW5SkLpKJs48dR5p5KkIW8OmEHU8lx6CZotiCDS9hkppQG=",
        "format": "AUTO",
        "overwrite": true
}

Response:
{}

手順 5: メタデータを取得する

AI/BI ダッシュボードなど、任意のワークスペースオブジェクトのメタデータを取得できます。 /api/2.0/workspace/get-status GET を参照してください。

次の例は、前の例からインポートしたダッシュボードの get-status 要求を示しています。応答には、ファイルが "DASHBOARD"として正常にインポートされたことを確認する詳細が含まれています。また、Lakeview API で識別子として使用できる "resource_id" プロパティで構成されます。

GET /api/2.0/workspace/get-status

Query parameters:
{
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json"
}

Response:
{
        "object_type": "DASHBOARD",
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json",
        "object_id": 7616304051637820,
        "resource_id": "9c1fbf4ad3449be67d6cb64c8acc730b"
}

手順 6: ダッシュボードを発行する

前の例では、ワークスペース API を使用して、汎用ワークスペースオブジェクトとして AI/BI ダッシュボードを操作できるようになりました。次の例では、Lakeview API を使用して、AI/BI ダッシュボードに固有の発行操作を実行します。 POST /api/2.0/lakeview/dashboards/{dashboard_id}/publishedを参照してください。

API エンドポイントへのパスには、前の例で返された "resource_id" プロパティが含まれています。要求パラメーターでは、発行元の資格情報がダッシュボードに埋め込まれるように、"embed_credentials" が true に設定されます。この場合、発行元は、承認された API 要求を行っているユーザーです。発行元は、別のユーザーの資格情報を埋め込むことができません。「ダッシュボードを発行する」を参照して、[資格情報の埋め込み] 設定のしくみを確認してください。

"warehouse_id" プロパティを使用すると、発行したダッシュボードに使用するウェアハウスを設定できます。指定した場合、このプロパティは、ドラフトダッシュボードに指定された倉庫 (存在する場合) をオーバーライドします。

POST /api/2.0/lakeview/dashboards/9c1fbf4ad3449be67d6cb64c8acc730b/published

Request parameters
{
  "embed_credentials": true,
  "warehouse_id": "1234567890ABCD12"
}

Response:
{}

発行されたダッシュボードは、コマンドの完了時にブラウザーからアクセスできます。次の例は、発行されたダッシュボードへのリンクを作成する方法を示しています。

https://<deployment-url>/dashboardsv3/<resource_id>/published

一意のリンクを作成するには:

<deployment-url> をデプロイ URL に置き換えます。このリンクは、Azure Databricks ワークスペースのホームページに表示されているブラウザーのアドレスバーのアドレスです。
<resource_id> を、「メタデータを取得する」で特定した "resource_id" プロパティの値に置き換えます。

手順 7: ダッシュボードを削除する

ダッシュボードを削除するには、ワークスペース API を使用します。 POST /api/2.0/workspace/delete に関するページを参照してください。

重要

これは物理的な削除です。コマンドが完了すると、ダッシュボードは完全に削除されます。

次の例では、要求に前の手順で作成したファイルへのパスが含まれています。

POST /api/2.0/workspace/delete

Query parameters:
{
        "path": "/Users/first.last@example.com/examples_folder/myseconddashboard.lvdash.json"
}

Response:
{}

次のステップ

ダッシュボードの詳細については、「ダッシュボード」を参照してください。
REST API の詳細については、Databricks REST API リファレンス参照してください。

次の方法で共有

ワークスペース API を使用してダッシュボードを管理する

前提条件

手順 1: ワークスペースディレクトリを探索する

手順 2: ダッシュボードをエクスポートする

エクスポートしたファイルをダウンロードする

エクスポートされたファイルをエンコードする

手順 3: ダッシュボードをインポートする

手順 4: インポート時に上書きする (省略可能)

手順 5: メタデータを取得する

手順 6: ダッシュボードを発行する

手順 7: ダッシュボードを削除する

次のステップ

フィードバック

その他のリソース

次の方法で共有

ワークスペース API を使用してダッシュボードを管理する

前提条件

手順 1: ワークスペース ディレクトリを探索する

手順 2: ダッシュボードをエクスポートする

エクスポートしたファイルをダウンロードする

エクスポートされたファイルをエンコードする

手順 3: ダッシュボードをインポートする

手順 4: インポート時に上書きする (省略可能)

手順 5: メタデータを取得する

手順 6: ダッシュボードを発行する

手順 7: ダッシュボードを削除する

次のステップ

フィードバック

その他のリソース

手順 1: ワークスペースディレクトリを探索する