GetReportStatus
This service obtains the status of either a specific report request or of all of the report requests visible to the user in the user's report output.
To request the status of a specific report specify the report's UID. The UID can be obtained when the report is submitted using SubmitReportSpec. The report spec must belong to the user or the status will not be returned.
To request the status of all of the user's report output do not specify the UID.
Request
The service request contains:
Name |
Data Type |
Required? |
Default Value |
Discussion |
|---|---|---|---|---|
ReportOutputUid |
long |
no |
|
64 bit integer that uniquely identifies the report output. If specified then the status of that report is returned. Otherwise the status of all of the user's reports is returned. |
Response
If the report spec exists and belongs to the user, then the following data is returned:
Name |
Data Type |
Discussion |
|---|---|---|
RowCount |
int |
Number of report outputs returned |
ReportOutputs |
see below |
List of ReportOutput records |
The ReportOutput record consists of:
Name |
Data Type |
Discussion |
|---|---|---|
ReportOutputUid |
long |
64 bit integer that uniquely identifies the report output |
ReportOutputFileUrl |
string(255) |
The URL of the report output file |
ReportStatus |
string(20) |
Queued, Running, Failed, Empty, Completed |
ReportFileSize |
int |
Size of the file in bytes |
ReportName |
string(50) |
Name of the report |
RequestedTimestamp |
DateTime |
Time (NYC Time, GMT-5) when report was queued |
CompletedTimestamp |
DateTime |
Time (NYC Time, GMT-5) when report was completed |