Reports - Get Export To File Status

Service:

Power BI REST APIs

API Version:

v1.0

從 [我的工作區] 傳回指定報表之[匯出至檔案] 作業的目前狀態。

當匯出作業狀態為 「成功」時，請使用 GetFileOfExportToFile API 來擷取檔案。

必要範圍

Report.ReadWrite.All 或 Report.Read.All

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

URI 參數

名稱	位於	必要	類型	Description
exportId	path	True	string	匯出識別碼
reportId	path	True	string uuid	報表識別碼

回應

名稱	類型	Description
200 OK	Export	確定
202 Accepted	Export	已接受

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/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"
}

定義

名稱	Description
Export	物件，描述匯出至檔案作業的詳細資料和目前狀態
ExportState	匯出至檔案作業的目前狀態

Export

物件，描述匯出至檔案作業的詳細資料和目前狀態

名稱	類型	Description
ResourceFileExtension	string	匯出檔案的副檔名
createdDateTime	string	匯出至檔案作業的開始日期和時間
expirationTime	string	擷取 URL 的到期日期和時間
id	string	匯出至檔案作業識別碼
lastActionDateTime	string	上次匯出至檔案作業之變更的日期和時間
percentComplete	integer	以百分比表示的作業進度
reportId	string	匯出報表的識別碼
reportName	string	匯出報表的名稱
resourceLocation	string	匯出檔案的擷取 URL
status	ExportState	匯出至檔案作業的目前狀態

ExportState

匯出至檔案作業的目前狀態

名稱	類型	Description
Failed	string	匯出至檔案作業失敗
NotStarted	string	匯出至檔案作業未啟動
Running	string	匯出至檔案作業正在執行中
Succeeded	string	已成功匯出至檔案作業
Undefined	string	匯出至檔案作業的狀態為未定義