Admin - WorkspaceInfo PostWorkspaceInfo

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

要求されたワークスペースの一覧のメタデータを受信する呼び出しを開始します。

重要

または datasetExpressions パラメーターを datasetSchema に設定するtrue場合は、データを返すためにメタデータスキャンを完全に有効にする必要があります。詳細については、「メタデータスキャンのテナント設定を有効にする」を参照してください。

アクセス許可

ユーザーは、管理者権限 (Microsoft 365 グローバル管理者や Power BI サービス管理者など) を持っているか、サービスプリンシパルを使用して認証する必要があります。

サービスプリンシパル認証で実行する場合、アプリには、Azure portalで Power BI に対して管理者の同意が必要なアクセス許可が設定されていない必要があります。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

標準の委任された管理者アクセストークンを使用して認証する場合にのみ関連します。サービスプリンシパル経由の認証を使用する場合は、存在しないようにする必要があります。

制限事項

1 時間あたり最大 500 要求。
最大 16 個の同時要求。

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}

URI パラメーター

名前	/	型	説明
datasetExpressions	query	boolean	データセット式 (DAX クエリとマッシュアップクエリ) を返すかどうか。このパラメーターをに設定する `true`場合は、データを返すためにメタデータスキャンを完全に有効にする必要があります。詳細については、「メタデータスキャンのテナント設定を有効にする」を参照してください。
datasetSchema	query	boolean	データセットスキーマ (テーブル、列、メジャー) を返すかどうか。このパラメーターをに設定する `true`場合は、データを返すためにメタデータスキャンを完全に有効にする必要があります。詳細については、「メタデータスキャンのテナント設定を有効にする」を参照してください。
datasourceDetails	query	boolean	データソースの詳細を返すかどうか
getArtifactUsers	query	boolean	Power BI アイテム (レポートやダッシュボードなど) のユーザーの詳細を返すかどうか
lineage	query	boolean	系列情報 (アップストリームデータフロー、タイル、データソース ID) を返すかどうか

要求本文

名前	型	説明
workspaces	string[]	スキャンに必要なワークスペース ID (1 から 100 個のワークスペース ID をサポート)

応答

名前	型	説明
202 Accepted	ScanRequest	同意

例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True

Request Body

{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Sample Response

Status code:: 202

{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

定義

名前	説明
PowerBIApiErrorResponseDetail	Power BI エラー応答に関する詳細情報
RequiredWorkspaces	必要なワークスペース要求
ScanRequest	スキャン要求

PowerBIApiErrorResponseDetail

Power BI エラー応答に関する詳細情報

名前	型	説明
code	string	エラーコード
message	string	エラーメッセージ
target	string	エラーターゲット

RequiredWorkspaces

必要なワークスペース要求

名前	型	説明
workspaces	string[]	スキャンに必要なワークスペース ID (1 から 100 個のワークスペース ID をサポート)

ScanRequest

スキャン要求

名前	型	説明
createdDateTime	string	スキャンの作成日時
error	PowerBIApiErrorResponseDetail	スキャンエラー (存在する場合)
id	string	スキャン ID
status	string	スキャンの状態