Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* Returns all of the active/completed reports for the current user
*/
@Api(Description="Returns all of the active/completed reports for the current user")
open class ListReports
{
var accountId:String? = null
}
open class ListReportsResponse
{
var reports:ArrayList<ReportInfo> = ArrayList<ReportInfo>()
}
open class ReportInfo
{
var id:String? = null
var name:String? = null
var status:ReportStatuses? = null
var statusMessage:String? = null
var dateCreated:String? = null
var dateUpdated:String? = null
var downloadLink:String? = null
var jobId:String? = null
var emailAddressToNotify:String? = null
var server:String? = null
}
enum class ReportStatuses
{
Queued,
Running,
Completed,
Error,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports HTTP/1.1 Host: evovoice.io Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"reports":[{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}]}