Dashboards - Add Dashboard In Group
在指定的工作区中创建新的空仪表板。
权限
此 API 调用可由服务主体配置文件调用。 有关详细信息，请参阅：Power BI Embedded中的服务主体配置文件。
所需范围
Content.Create
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboardsURI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
group
|
path | True |
string (uuid) |
工作区 ID |
请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| name | True |
string |
新仪表板的名称 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
还行 |
示例
Example
示例请求
POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards{
"name": "SalesMarketing"
}示例响应
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
"isReadOnly": false
}定义
| 名称 | 说明 |
|---|---|
|
Add |
添加仪表板的 Power BI 请求 |
| Dashboard |
Power BI 仪表板。 API 返回以下仪表板属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。 |
|
Dashboard |
仪表板的 Power BI 用户访问权限条目 |
|
Dashboard |
用户对仪表板拥有的访问权限（权限级别） |
|
Principal |
主体类型 |
|
Service |
Power BI 服务主体配置文件。 仅适用于 Power BI Embedded 多租户解决方案。 |
| Subscription |
Power BI 项的电子邮件订阅（例如报表或仪表板） |
|
Subscription |
Power BI 电子邮件订阅用户 |
AddDashboardRequest
添加仪表板的 Power BI 请求
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
新仪表板的名称 |
Dashboard
Power BI 仪表板。 API 返回以下仪表板属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
| 名称 | 类型 | 说明 |
|---|---|---|
| appId |
string |
仅当仪表板属于应用时才返回的应用 ID |
| displayName |
string |
仪表板的显示名称 |
| embedUrl |
string |
仪表板的嵌入 URL |
| id |
string (uuid) |
仪表板 ID |
| isReadOnly |
boolean |
仪表板是否为只读 |
| subscriptions |
（空值）Power BI 项（例如报表或仪表板）的订阅详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取报表订阅作为管理员 API 调用来检索 Power BI 报表的订阅信息。 |
|
| users |
（空值）仪表板用户访问详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取仪表板用户作为管理员 API 调用，或使用 参数 |
|
| webUrl |
string |
仪表板的 Web URL |
DashboardUser
仪表板的 Power BI 用户访问权限条目
| 名称 | 类型 | 说明 |
|---|---|---|
| dashboardUserAccessRight |
用户对仪表板拥有的访问权限（权限级别） |
|
| displayName |
string |
主体的显示名称 |
| emailAddress |
string |
用户电子邮件地址 |
| graphId |
string |
Microsoft Graph 中主体的标识符。 仅适用于管理员 API。 |
| identifier |
string |
主体的标识符 |
| principalType |
主体类型 |
|
| profile |
Power BI 服务主体配置文件。 仅适用于 Power BI Embedded 多租户解决方案。 |
|
| userType |
string |
用户的类型。 |
DashboardUserAccessRight
用户对仪表板拥有的访问权限（权限级别）
| 值 | 说明 |
|---|---|
| None |
无权访问仪表板中的内容 |
| Owner |
授予对报表中内容的读取、写入和重新共享访问权限 |
| Read |
授予对仪表板中内容的读取访问权限 |
| ReadCopy |
授予对仪表板中内容的读取和复制访问权限 |
| ReadReshare |
授予对仪表板中内容的读取和重新共享访问权限 |
| ReadWrite |
授予对仪表板中内容的读取和写入访问权限 |
PrincipalType
主体类型
| 值 | 说明 |
|---|---|
| App |
服务主体类型 |
| Group |
组主体类型 |
| None |
无主体类型。 用于整个组织级别的访问。 |
| User |
用户主体类型 |
ServicePrincipalProfile
Power BI 服务主体配置文件。 仅适用于 Power BI Embedded 多租户解决方案。
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
服务主体配置文件名称 |
| id |
string (uuid) |
服务主体配置文件 ID |
Subscription
Power BI 项的电子邮件订阅（例如报表或仪表板）
| 名称 | 类型 | 说明 |
|---|---|---|
| artifactDisplayName |
string |
订阅的 Power BI 项的名称（例如报表或仪表板） |
| artifactId |
string (uuid) |
订阅的 Power BI 项的 ID（例如报表或仪表板） |
| artifactType |
string |
Power BI 项的类型（例如 |
| attachmentFormat |
string |
电子邮件订阅中附加的报表的格式 |
| endDate |
string (date-time) |
电子邮件订阅的结束日期和时间 |
| frequency |
string |
电子邮件订阅的频率 |
| id |
string (uuid) |
订阅 ID |
| isEnabled |
boolean |
是否启用电子邮件订阅 |
| linkToContent |
boolean |
电子邮件订阅中是否存在订阅链接 |
| previewImage |
boolean |
电子邮件订阅中是否存在报表的屏幕截图 |
| startDate |
string (date-time) |
电子邮件订阅的开始日期和时间 |
| subArtifactDisplayName |
string |
订阅的 Power BI 项的页面名称（如果是报表）。 |
| title |
string |
应用名称 |
| users |
每个电子邮件订阅者的详细信息。 使用 获取用户订阅作为管理员 API 调用时，返回的值是空数组（null）。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 以 管理员身份获取报表订阅或 获取仪表板订阅作为管理员 API 调用来检索 Power BI 报表或仪表板上的订阅信息。 |
SubscriptionUser
Power BI 电子邮件订阅用户
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
主体的显示名称 |
| emailAddress |
string |
用户电子邮件地址 |
| graphId |
string |
Microsoft Graph 中主体的标识符。 仅适用于管理员 API。 |
| identifier |
string |
主体的标识符 |
| principalType |
主体类型 |
|
| profile |
Power BI 服务主体配置文件。 仅适用于 Power BI Embedded 多租户解决方案。 |
|
| userType |
string |
用户的类型。 |