Admin - WorkspaceInfo PostWorkspaceInfo

服务:: Power BI REST APIs

API 版本:: v1.0

启动调用以接收请求的工作区列表的元数据。

重要

如果将 datasetSchema 或 datasetExpressions 参数设置为 true，则必须完全启用元数据扫描才能返回数据。有关详细信息，请参阅启用元数据扫描的租户设置。

权限

用户必须是 Fabric 管理员或使用服务主体进行身份验证。

在服务主体身份验证下运行时，应用不得在 Azure 门户中为其上设置的 Power BI 具有任何管理员许可所需的权限。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

仅在通过标准委派管理员访问令牌进行身份验证时相关。使用服务主体进行身份验证时不得存在。

局限性

每小时最多 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 和 Mashup 查询）。如果将此参数设置为 `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	扫描状态