Reports - Export To File In Group

将指定工作区中的指定报表导出为请求的 文件格式

此 API 是异步的。 调用 API 时,它会触发导出作业。 触发导出作业后,使用 GetExportToFileStatus API 跟踪作业状态。 详细了解整个流: 导出 Power BI 报表导出分页报表

权限

此 API 调用可由服务主体配置文件调用。 有关详细信息,请参阅:Power BI Embedded中的服务主体配置文件

必需范围

以下所有项:

  • Report.ReadWrite.All 或 Report.Read.All
  • Dataset.ReadWrite.All 或 Dataset.Read.All

限制

检查将 Power BI 报表导出到文件和将分页报表导出到文件中的限制。

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/ExportTo

URI 参数

名称 必需 类型 说明
groupId
path True

string

uuid

工作区 ID

reportId
path True

string

uuid

报表 ID

请求正文

名称 必需 类型 说明
format True

FileFormat

所导出文件的请求格式

paginatedReportConfiguration

PaginatedReportExportConfiguration

用于导出分页报表的配置

powerBIReportConfiguration

PowerBIReportExportConfiguration

用于导出 Power BI 报表的配置

响应

名称 类型 说明
202 Accepted

Export

已接受

定义

名称 说明
EffectiveIdentity

定义用户标识和角色。 有关详细信息,请参阅使用 Power BI Embedded 的行级别安全性

Export

描述导出到文件作业的详细信息和当前状态的 对象

ExportFilter

导出操作期间要应用的筛选器

ExportReportPage

导出请求的单页配置

ExportReportRequest

导出到文件请求

ExportReportSettings

导出到文件请求设置

ExportState

导出到文件作业的当前状态

FileFormat

所导出文件的请求格式

IdentityBlob

用于指定标识的 Blob。 仅支持与 Azure SQL 建立 DirectQuery 连接的数据集

PageBookmark

要应用于单个页面上的书签。 提供名称或状态,但不能同时提供两者。

PaginatedReportExportConfiguration

分页报表的导出到文件配置

ParameterValue

分页报表参数的数据协定

PowerBIReportExportConfiguration

Power BI 报表的导出到文件配置

EffectiveIdentity

定义用户标识和角色。 有关详细信息,请参阅使用 Power BI Embedded 的行级别安全性

名称 类型 说明
auditableContext

string

EffectiveIdentity 可审核上下文。 如果此参数已提供且不为空,它将启用 EffectiveIdentity 的审核,并且其值将设置为审核记录中的用户名。 否则,GenerateToken 审核记录中将省略 EffectiveIdentity 上下文。

customData

string

用于应用行级别安全规则的自定义数据。 仅支持与Azure Analysis Services模型和云模型的实时连接。

datasets

string[]

应用此标识的数据集数组

identityBlob

IdentityBlob

一个指定 标识的 Blob。 仅支持与 Azure SQL 建立 DirectQuery 连接的数据集。

reports

string[]

应用此标识的报表数组。 仅分页报表支持。

roles

string[]

行级安全 (RLS) 应用 RLS 规则的令牌中的角色数组。 一个标识最多可以包含 50 个角色。 角色可以包含除 之外 ,的任何字符,其长度不得超过 50 个字符。

username

string

应用行级安全规则的令牌中的有效用户名。 对于本地模型,用户名可以包含字母数字或以下任意字符 .、、-_!^#、、~、 。 @\\ 对于云模型,用户名可以包含任何 ASCII 字符。 对于任一模型,用户名长度不得超过 256 个字符,并且用户名不应包含空格。

Export

描述导出到文件作业的详细信息和当前状态的 对象

名称 类型 说明
ResourceFileExtension

string

导出文件的扩展名

createdDateTime

string

导出到文件作业的开始日期和时间

expirationTime

string

检索 URL 的过期日期和时间

id

string

导出到文件作业 ID

lastActionDateTime

string

导出到文件作业的上次更改的日期和时间

percentComplete

integer

以百分比表示的作业进度

reportId

string

导出报表的 ID

reportName

string

导出的报表的名称

resourceLocation

string

导出文件的检索 URL

status

ExportState

导出到文件作业的当前状态

ExportFilter

导出操作期间要应用的筛选器

名称 类型 说明
filter

string

要应用的筛选器。 有关筛选器语法的信息,请参阅 筛选报表

ExportReportPage

导出请求的单页配置

名称 类型 说明
bookmark

PageBookmark

要应用于页面上的书签

pageName

string

页面名称

visualName

string

要导出的视觉对象的名称。 指定名称,以防仅导出此页面中的单个视觉对象。

ExportReportRequest

导出到文件请求

名称 类型 说明
format

FileFormat

所导出文件的请求格式

paginatedReportConfiguration

PaginatedReportExportConfiguration

用于导出分页报表的配置

powerBIReportConfiguration

PowerBIReportExportConfiguration

用于导出 Power BI 报表的配置

ExportReportSettings

导出到文件请求设置

名称 类型 说明
includeHiddenPages

boolean

导出整个报表时是否包含隐藏页。 如果未提供,则默认行为是排除隐藏页面。 导出特定页面时,将忽略此属性。

locale

string

要应用的区域设置

ExportState

导出到文件作业的当前状态

名称 类型 说明
Failed

string

导出到文件作业失败

NotStarted

string

导出到文件作业未启动

Running

string

导出到文件作业正在运行

Succeeded

string

导出到文件作业已成功完成

Undefined

string

导出到文件作业的状态未定义

FileFormat

所导出文件的请求格式

名称 类型 说明
ACCESSIBLEPDF

string

辅助 PDF (仅支持分页报表)

CSV

string

CSV (仅支持分页报表)

DOCX

string

Microsoft Word (仅支持分页报表)

IMAGE

string

仅分页报表支持 BMP、EMF、GIF、JPEG、PNG 或 TIFF 图像 格式 ()

MHTML

string

MHTML (仅支持分页报表)

PDF

string

PDF

PNG

string

PNG (仅支持 Power BI 报表)

PPTX

string

Microsoft PowerPoint

XLSX

string

Microsoft Excel (仅支持分页报表)

XML

string

XML (仅支持分页报表)

IdentityBlob

用于指定标识的 Blob。 仅支持与 Azure SQL 建立 DirectQuery 连接的数据集

名称 类型 说明
value

string

用于Azure SQL的 OAuth 2.0 访问令牌

PageBookmark

要应用于单个页面上的书签。 提供名称或状态,但不能同时提供两者。

名称 类型 说明
name

string

书签名称

state

string

书签状态

PaginatedReportExportConfiguration

分页报表的导出到文件配置

名称 类型 说明
formatSettings

object

格式设置的字典。 键是所请求文件格式的设备信息属性名称。

identities

EffectiveIdentity[]

导出报表时要使用的单个标识。 当报表使用 Power BI 数据集或Azure Analysis Services数据源时是必需的。

parameterValues

ParameterValue[]

报表参数列表

ParameterValue

分页报表参数的数据协定

名称 类型 说明
name

string

参数名称

value

string

参数值

PowerBIReportExportConfiguration

Power BI 报表的导出到文件配置

名称 类型 说明
datasetToBind

string

用于导出报表的数据集 ID。 仅当使用报表的默认数据集以外的数据集导出时才需要。

defaultBookmark

PageBookmark

要应用于没有特定书签的所有页面的默认书签

identities

EffectiveIdentity[]

用于行级别安全规则的标识列表

pages

ExportReportPage[]

要导出的页面及其属性的列表。 同一页面可能会多次显示不同的视觉对象。

reportLevelFilters

ExportFilter[]

要应用的报表级别筛选器的列表。 目前仅支持一个筛选器。

settings

ExportReportSettings

要应用于导出到文件作业的设置