Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum ReportStatuses
{
Queued = 'Queued',
Running = 'Running',
Completed = 'Completed',
Error = 'Error',
}
export class ReportInfo
{
public id: string;
public name: string;
public status: ReportStatuses;
public statusMessage: string;
public dateCreated: string;
public dateUpdated: string;
public downloadLink: string;
public jobId: string;
public emailAddressToNotify: string;
public server: string;
public constructor(init?: Partial<ReportInfo>) { (Object as any).assign(this, init); }
}
export class ListReportsResponse
{
public reports: ReportInfo[];
public constructor(init?: Partial<ListReportsResponse>) { (Object as any).assign(this, init); }
}
/** @description Returns all of the active/completed reports for the current user */
// @Api(Description="Returns all of the active/completed reports for the current user")
export class ListReports
{
public accountId: string;
public constructor(init?: Partial<ListReports>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListReportsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports"> <Reports> <ReportInfo> <DateCreated>String</DateCreated> <DateUpdated>String</DateUpdated> <DownloadLink>String</DownloadLink> <EmailAddressToNotify>String</EmailAddressToNotify> <Id>String</Id> <JobId>String</JobId> <Name>String</Name> <Server>String</Server> <Status>Queued</Status> <StatusMessage>String</StatusMessage> </ReportInfo> </Reports> </ListReportsResponse>