Trendsic Platform Service

<back to all web services

ReportDefinitionListRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/definitions

export class SavedReportDefinition
{
    public ReportDefinitionID: number;
    public ReportDefinitionUID: string;
    public Name: string;
    public Folder: string;
    public Kind: string;
    public ChartType: string;
    public DefinitionJson: string;
    public IsShared: boolean;
    public IsSystem: boolean;
    public OwnerUserId: string;
    public IsMine: boolean;
    public CreatedAt?: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<SavedReportDefinition>) { (Object as any).assign(this, init); }
}

export class ReportDefinitionListResponse
{
    public ResponseStatus: ResponseStatus;
    public Definitions: SavedReportDefinition[] = [];

    public constructor(init?: Partial<ReportDefinitionListResponse>) { (Object as any).assign(this, init); }
}

export class ReportDefinitionListRequest
{

    public constructor(init?: Partial<ReportDefinitionListRequest>) { (Object as any).assign(this, init); }
}

TypeScript ReportDefinitionListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/report/definitions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Definitions":[{"ReportDefinitionID":0,"ReportDefinitionUID":"00000000000000000000000000000000","Name":"String","Folder":"String","Kind":"String","ChartType":"String","DefinitionJson":"String","IsShared":false,"IsSystem":false,"OwnerUserId":"String","IsMine":false,"CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}]}