Reports - Get Export To File Status
Returns the status of the Export to file job from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
export
|
path | True |
|
The export id |
report
|
path | True |
|
The report id |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Accepted |
Definitions
Export |
An object describing Export to file details and current state |
Export |
The current state of the Export to file job |
Export
An object describing Export to file details and current state
Name | Type | Description |
---|---|---|
ResourceFileExtension |
|
The extension of the exported file |
createdDateTime |
|
The start time of the Export to file job |
expirationTime |
|
The expiration time of the URL |
id |
|
The Export to file job ID |
lastActionDateTime |
|
The time of last change in the Export to file job |
percentComplete |
|
Indicate job progress as percentage |
reportId |
|
The ID of the exported report |
reportName |
|
The name of the exported report |
resourceLocation |
|
The URL for retrieving the exported file |
status |
The current state of the Export to file job |
ExportState
The current state of the Export to file job
Name | Type | Description |
---|---|---|
Failed |
|
Indicates that the Export to file job failed |
NotStarted |
|
Indicates that the Export to file job did not start |
Running |
|
Indicates that the Export to file job is running |
Succeeded |
|
Indicates that the Export to file job finished succesfully |
Undefined |
|
Indicates that the state of the Export to file job is undefined |