Admin - WorkspaceInfo PostWorkspaceInfo

參考

Service:: Power BI REST APIs

API Version:: v1.0

起始呼叫以接收所要求工作區清單的中繼資料。

重要

如果您將 datasetSchema 或 datasetExpressions 參數設定為 true ，則必須完整啟用中繼資料掃描，才能傳回資料。如需詳細資訊，請參閱啟用中繼資料掃描的租使用者設定。

權限

使用者必須具有系統管理員許可權 (，例如 Microsoft 365 全域管理員或 Power BI 服務管理員) 或使用服務主體進行驗證。

在服務主體驗證下執行時，應用程式不得在Azure 入口網站中設定 Power BI 的任何系統管理員同意許可權。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

只有在透過標準委派的系統管理員存取權杖進行驗證時才相關。使用透過服務主體進行驗證時，不得存在。

限制

每小時最多 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 參數

名稱	位於	類型	Description
datasetExpressions	query	boolean	是否 (DAX 和 Mashup 查詢傳回資料集運算式) 。如果您將此參數設定為 `true` ，則必須完整啟用中繼資料掃描，才能傳回資料。如需詳細資訊，請參閱啟用中繼資料掃描的租使用者設定。
datasetSchema	query	boolean	是否 (資料表、資料行和量值) 傳回資料集架構。如果您將此參數設定為 `true` ，則必須完整啟用中繼資料掃描，才能傳回資料。如需詳細資訊，請參閱啟用中繼資料掃描的租使用者設定。
datasourceDetails	query	boolean	是否傳回資料來源詳細資料
getArtifactUsers	query	boolean	是否傳回 Power BI 專案的使用者詳細資料 (，例如報表或儀表板)
lineage	query	boolean	是否 (上游資料流程、磚、資料來源識別碼) 傳回曆程資訊

要求本文

名稱	類型	Description
workspaces	string[]	(掃描所需的工作區識別碼支援 1 到 100 個工作區識別碼)

回應

名稱	類型	Description
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"
}

定義

名稱	Description
PowerBIApiErrorResponseDetail	Power BI 錯誤回應的詳細資訊
RequiredWorkspaces	必要的工作區要求
ScanRequest	掃描要求

PowerBIApiErrorResponseDetail

Power BI 錯誤回應的詳細資訊

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息。
target	string	錯誤目標

RequiredWorkspaces

必要的工作區要求

名稱	類型	Description
workspaces	string[]	(掃描所需的工作區識別碼支援 1 到 100 個工作區識別碼)

ScanRequest

掃描要求

名稱	類型	Description
createdDateTime	string	掃描建立日期和時間
error	PowerBIApiErrorResponseDetail	如果有任何) ，掃描錯誤 (
id	string	掃描識別碼
status	string	掃描狀態

共用方式為