Reports - Get Export To File Status

服务:

Power BI REST APIs

API 版本:

v1.0

从“我的工作区”返回指定报表 导出到文件 作业的当前状态。

当导出作业状态为“Succeeded”时，请使用 GetFileOfExportToFile API 检索文件。

所需范围

Report.ReadWrite.All 或 Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}

URI 参数

名称	在	必需	类型	说明
exportId	path	True	string	导出 ID
reportId	path	True	string (uuid)	报表 ID

响应

名称	类型	说明
200 OK	Export	还行
202 Accepted	Export	已接受

示例

Example

示例请求

GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}

示例响应

状态代码:

200

{
  "id": "Mi9C5419i....PS4=",
  "createdDateTime": "2021-12-08T10:26:09.3069086Z",
  "lastActionDateTime": "2021-12-08T10:26:38.016851Z",
  "reportId": "cad51cfa-e740-324f-acbb-8ca43c40a2d4",
  "reportName": "Report name",
  "status": "Succeeded",
  "percentComplete": 100,
  "resourceLocation": "...Mi9C5419i....PS4=/file",
  "resourceFileExtension": ".pptx",
  "expirationTime": "2021-12-09T10:26:11.586756Z"
}

定义

名称	说明
Export	描述导出到文件作业的详细信息和当前状态的对象
ExportState	导出到文件作业的当前状态

Export

Object

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

名称	类型	说明
createdDateTime	string (date-time)	导出到文件作业的开始日期和时间
expirationTime	string (date-time)	检索 URL 的到期日期和时间
id	string	导出到文件作业 ID
lastActionDateTime	string (date-time)	上次对导出到文件作业的更改的日期和时间
percentComplete	integer (int32) minimum: 0 maximum: 100	作业进度百分比
reportId	string (uuid)	导出报表的 ID
reportName	string	导出报表的名称
resourceFileExtension	string	导出文件的扩展名
resourceLocation	string	导出文件的检索 URL
status	ExportState	导出到文件作业的当前状态

ExportState

枚举

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

值	说明
Failed	导出到文件作业失败
NotStarted	导出到文件作业未启动
Running	导出到文件作业正在运行
Succeeded	导出到文件作业成功完成
Undefined	导出到文件作业的状态未定义