Dashboards - Get Dashboards

参考

Service:: Power BI REST APIs

API Version:: v1.0

从 “我的工作区”返回仪表板列表。

此 API 还会从共享应用返回共享仪表板和仪表板。可以使用 “获取组中的仪表板”API 访问驻留在共享工作区中的仪表板。

必需范围

Dashboard.ReadWrite.All 或 Dashboard.Read.All

GET https://api.powerbi.com/v1.0/myorg/dashboards

响应

名称	类型	说明
200 OK	Dashboards	确定

示例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/dashboards

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false
    }
  ]
}

定义

名称	说明
Dashboard	Power BI 仪表板。 API 返回以下仪表板属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
Dashboards	Power BI 仪表板集合的 OData 响应包装器
DashboardUser	仪表板的 Power BI 用户访问权限条目
DashboardUserAccessRight	用户对仪表板的访问权限 (权限级别)
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
Subscription	Power BI 项的电子邮件订阅 (，例如报表或仪表板)
SubscriptionUser	Power BI 电子邮件订阅用户

Dashboard

Power BI 仪表板。 API 返回以下仪表板属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称	类型	说明
appId	string	应用 ID，仅当仪表板属于某个应用时才返回
displayName	string	仪表板的显示名称
embedUrl	string	仪表板的嵌入 URL
id	string	仪表板 ID
isReadOnly	boolean	仪表板是否为只读
subscriptions	Subscription[]	(空值) Power BI 项 (（如报表或仪表板) ）的订阅详细信息。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取报表订阅作为管理员 API 调用来检索 Power BI 报表的订阅信息。
users	DashboardUser[]	() 仪表板用户访问详细信息的空值。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取仪表板用户作为管理员 API 调用或 PostWorkspaceInfo API 调用和参数检索 Power BI 仪表板上的用户`getArtifactUsers`信息。
webUrl	string	仪表板的 Web URL

Dashboards

Power BI 仪表板集合的 OData 响应包装器

名称	类型	说明
odata.context	string	OData 上下文
value	Dashboard[]	仪表板集合

DashboardUser

仪表板的 Power BI 用户访问权限条目

名称	类型	说明
dashboardUserAccessRight	DashboardUserAccessRight	用户对仪表板的访问权限 (权限级别)
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。仅适用于管理员 API。
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
userType	string	用户的类型。

DashboardUserAccessRight

用户对仪表板的访问权限 (权限级别)

名称	类型	说明
None	string	对仪表板中的内容没有权限
Owner	string	授予对报表中内容的读取、写入和重新共享访问权限
Read	string	授予对仪表板中内容的读取访问权限
ReadCopy	string	授予对仪表板中内容的读取和复制访问权限
ReadReshare	string	授予对仪表板中内容的读取和重新共享访问权限
ReadWrite	string	授予对仪表板中内容的读取和写入访问权限

PrincipalType

主体类型

名称	类型	说明
App	string	服务主体类型
Group	string	组主体类型
None	string	无主体类型。用于整个组织级别的访问。
User	string	用户主体类型

ServicePrincipalProfile

Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。

名称	类型	说明
displayName	string	服务主体配置文件名称
id	string	服务主体配置文件 ID

Subscription

Power BI 项的电子邮件订阅 (，例如报表或仪表板)

名称	类型	说明
artifactDisplayName	string	订阅的 Power BI 项的名称 (，例如报表或仪表板)
artifactId	string	订阅的 Power BI 项 (的 ID，例如报表或仪表板)
artifactType	string	Power BI 项的类型 (例如 `Report`、 `Dashboard`或 `Dataset`)
attachmentFormat	string	电子邮件订阅中附加的报表的格式
endDate	string	电子邮件订阅的结束日期和时间
frequency	string	电子邮件订阅的频率
id	string	订阅 ID
isEnabled	boolean	是否启用电子邮件订阅
linkToContent	boolean	电子邮件订阅中是否存在订阅链接
previewImage	boolean	电子邮件订阅中是否存在报表的屏幕截图
startDate	string	电子邮件订阅的开始日期和时间
subArtifactDisplayName	string	订阅的 Power BI 项的页面名称（如果是报表）。
title	string	应用名称
users	SubscriptionUser[]	每个电子邮件订阅者的详细信息。使用获取用户订阅作为管理员 API 调用时，返回的值是空数组， (null) 。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取报表订阅作为管理员或获取仪表板订阅作为管理员 API 调用检索 Power BI 报表或仪表板上的订阅信息。

SubscriptionUser

Power BI 电子邮件订阅用户

名称	类型	说明
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。仅适用于管理员 API。
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
userType	string	用户的类型。

通过