通过

Reports - Update Report Content

  • 参考
服务:
Power BI REST APIs
API 版本:
v1.0

使用指定源报表的内容从“我的工作区”更新指定报表的内容。

在请求正文中指定源报表。

所需范围

Report.ReadWrite.All

POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/UpdateReportContent

URI 参数

名称 在 必需 类型 说明
reportId
 path True

string (uuid)

报表 ID

请求正文

名称 必需 类型 说明
sourceReport True

SourceReport

现有源报表
sourceType True

sourceType

内容更新的源类型

响应

名称 类型 说明
200 OK

Report

还行

示例

Example

示例请求

POST https://api.powerbi.com/v1.0/myorg/reports/5b218778-e7a5-4d73-8187-f10824047715/UpdateReportContent
请求正文
{
  "sourceReport": {
    "sourceReportId": "8e4d5880-81d6-4804-ab97-054665050799",
    "sourceWorkspaceId": "2f42a406-a075-4a15-bbf2-97ef958c94cb"
  },
  "sourceType": "ExistingReport"
}

示例响应

状态代码:
200

定义

名称 说明
PrincipalType

主体类型
Report

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

报表的 Power BI 用户访问权限条目
ReportUserAccessRight

用户对报表拥有的访问权限（权限级别）
ServicePrincipalProfile

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

现有源报表
sourceType

内容更新的源类型
Subscription

Power BI 项的电子邮件订阅（例如报表或仪表板）
SubscriptionUser

Power BI 电子邮件订阅用户
UpdateReportContentRequest

更新报表内容的 Power BI 请求

PrincipalType

枚举

主体类型

值 说明
App

服务主体类型
Group

组主体类型
None

无主体类型。 用于整个组织级别的访问。
User

用户主体类型

Report

Object

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

名称 类型 说明
appId

string

仅当报表属于应用时才返回的应用 ID
datasetId

string

报表的数据集 ID
description

string

报表说明
embedUrl

string

报表的嵌入 URL
id

string (uuid)

报表 ID
isOwnedByMe

boolean

指示当前用户是否可以修改或创建报表的副本。
name

string

报表的名称。 应用报告以前缀 [App] 开头。
originalReportId

string (uuid)

工作区发布为应用时的实际报表 ID。
reportType enum:
  • PaginatedReport
  • PowerBIReport

报表类型
subscriptions

Subscription[]

（空值）Power BI 项（例如报表或仪表板）的订阅详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取报表订阅作为管理员 API 调用来检索 Power BI 报表的订阅信息。
users

ReportUser[]

（空值）Power BI 报表的用户访问详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取报表用户作为管理员 API 调用，或使用 参数 getArtifactUsers API 调用来检索有关 Power BI 报表的用户信息。
webUrl

string

报表的 Web URL

ReportUser

Object

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

名称 类型 说明
displayName

string

主体的显示名称
emailAddress

string

用户电子邮件地址
graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。
identifier

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

ReportUserAccessRight

用户对报表拥有的访问权限（权限级别）
userType

string

用户的类型。

ReportUserAccessRight

枚举

用户对报表拥有的访问权限（权限级别）

值 说明
None

对报表中的内容没有权限
Owner

授予对报表中内容的读取、写入和重新共享访问权限
Read

授予对报表中内容的读取访问权限
ReadCopy

授予对报表中内容的读取和复制访问权限
ReadReshare

授予对报表中内容的读取和重新共享访问权限
ReadWrite

授予对报表中内容的读取和写入访问权限

ServicePrincipalProfile

Object

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

名称 类型 说明
displayName

string

服务主体配置文件名称
id

string (uuid)

服务主体配置文件 ID

SourceReport

Object

现有源报表

名称 类型 说明
sourceReportId

string (uuid)

源报表 ID
sourceWorkspaceId

string (uuid)

源工作区 ID

sourceType

枚举

内容更新的源类型

值 说明
ExistingReport

使用现有报表作为用于更新目标报表的内容源

Subscription

Object

Power BI 项的电子邮件订阅（例如报表或仪表板）

名称 类型 说明
artifactDisplayName

string

订阅的 Power BI 项的名称（例如报表或仪表板）
artifactId

string (uuid)

订阅的 Power BI 项的 ID（例如报表或仪表板）
artifactType

string

Power BI 项的类型（例如 Report、Dashboard或 Dataset）
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

SubscriptionUser[]

每个电子邮件订阅者的详细信息。 使用 获取用户订阅作为管理员 API 调用时，返回的值是空数组（null）。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 以 管理员身份获取报表订阅或 获取仪表板订阅作为管理员 API 调用来检索 Power BI 报表或仪表板上的订阅信息。

SubscriptionUser

Object

Power BI 电子邮件订阅用户

名称 类型 说明
displayName

string

主体的显示名称
emailAddress

string

用户电子邮件地址
graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。
identifier

string

主体的标识符
principalType

PrincipalType

主体类型
profile

ServicePrincipalProfile

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

string

用户的类型。

UpdateReportContentRequest

Object

更新报表内容的 Power BI 请求

名称 类型 说明
sourceReport

SourceReport

现有源报表
sourceType

sourceType

内容更新的源类型