Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Returns all of the active/completed reports for the current user
*/
@Api(Description="Returns all of the active/completed reports for the current user")
public static class ListReports
{
public String accountId = null;
public String getAccountId() { return accountId; }
public ListReports setAccountId(String value) { this.accountId = value; return this; }
}
public static class ListReportsResponse
{
public ArrayList<ReportInfo> reports = null;
public ArrayList<ReportInfo> getReports() { return reports; }
public ListReportsResponse setReports(ArrayList<ReportInfo> value) { this.reports = value; return this; }
}
public static class ReportInfo
{
public String id = null;
public String name = null;
public ReportStatuses status = null;
public String statusMessage = null;
public String dateCreated = null;
public String dateUpdated = null;
public String downloadLink = null;
public String jobId = null;
public String emailAddressToNotify = null;
public String server = null;
public String getId() { return id; }
public ReportInfo setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public ReportInfo setName(String value) { this.name = value; return this; }
public ReportStatuses getStatus() { return status; }
public ReportInfo setStatus(ReportStatuses value) { this.status = value; return this; }
public String getStatusMessage() { return statusMessage; }
public ReportInfo setStatusMessage(String value) { this.statusMessage = value; return this; }
public String getDateCreated() { return dateCreated; }
public ReportInfo setDateCreated(String value) { this.dateCreated = value; return this; }
public String getDateUpdated() { return dateUpdated; }
public ReportInfo setDateUpdated(String value) { this.dateUpdated = value; return this; }
public String getDownloadLink() { return downloadLink; }
public ReportInfo setDownloadLink(String value) { this.downloadLink = value; return this; }
public String getJobId() { return jobId; }
public ReportInfo setJobId(String value) { this.jobId = value; return this; }
public String getEmailAddressToNotify() { return emailAddressToNotify; }
public ReportInfo setEmailAddressToNotify(String value) { this.emailAddressToNotify = value; return this; }
public String getServer() { return server; }
public ReportInfo setServer(String value) { this.server = value; return this; }
}
public static enum 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: team.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"}]}