Reports - Get Export To File Status In Group

Service:

Power BI REST APIs

API Version:

v1.0

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

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

权限

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

所需范围

Report.ReadWrite.All 或 Report.Read.All

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

URI 参数

名称	在	必需	类型	说明
exportId	path	True	string	导出 ID
groupId	path	True	string uuid	工作区 ID
reportId	path	True	string uuid	报表 ID

响应

名称	类型	说明
200 OK	Export	确定
202 Accepted	Export	已接受

示例

Example

Sample Request

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

Sample Response

Status code:

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

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

名称	类型	说明
ResourceFileExtension	string	导出文件的扩展名
createdDateTime	string	导出到文件作业的开始日期和时间
expirationTime	string	检索 URL 的过期日期和时间
id	string	导出到文件作业 ID
lastActionDateTime	string	导出到文件作业的上次更改的日期和时间
percentComplete	integer	以百分比表示的作业进度
reportId	string	导出报表的 ID
reportName	string	导出的报表的名称
resourceLocation	string	导出文件的检索 URL
status	ExportState	导出到文件作业的当前状态

ExportState

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

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