Admin - WorkspaceInfo PostWorkspaceInfo

サービス:

Power BI REST APIs

API バージョン:

v1.0

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

Important

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

Permissions

ユーザーは、ファブリック管理者であるか、サービス プリンシパルを使用して認証されている必要があります。

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

必要なスコープ

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

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

制限事項

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

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

省略可能なパラメーターを含む:

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[] (uuid)	スキャンする必要があるワークスペース ID (1 ~ 100 個のワークスペース ID をサポート)

応答

名前	型	説明
202 Accepted	ScanRequest	受け入れ られる

例

Example

要求のサンプル

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

要求本文

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

応答のサンプル

状態コード:

202

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

定義

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

PowerBIApiErrorResponseDetail

Object

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

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

RequiredWorkspaces

Object

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

名前	型	説明
workspaces	string[] (uuid)	スキャンする必要があるワークスペース ID (1 ~ 100 個のワークスペース ID をサポート)

ScanRequest

Object

スキャン要求

名前	型	説明
createdDateTime	string (date-time)	スキャンの作成日時
error	PowerBIApiErrorResponseDetail	スキャン エラー (ある場合)
id	string (uuid)	スキャン ID
status	string	スキャン状態