Trendsic Platform Service

<back to all web services

ReportDefinitionCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/definitions
"use strict";
export class SavedReportDefinition {
    /** @param {{ReportDefinitionID?:number,ReportDefinitionUID?:string,Name?:string,Folder?:string,Kind?:string,ChartType?:string,DefinitionJson?:string,IsShared?:boolean,IsSystem?:boolean,OwnerUserId?:string,IsMine?:boolean,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ReportDefinitionID;
    /** @type {string} */
    ReportDefinitionUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Folder;
    /** @type {string} */
    Kind;
    /** @type {string} */
    ChartType;
    /** @type {string} */
    DefinitionJson;
    /** @type {boolean} */
    IsShared;
    /** @type {boolean} */
    IsSystem;
    /** @type {string} */
    OwnerUserId;
    /** @type {boolean} */
    IsMine;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ReportDefinitionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Definition?:SavedReportDefinition}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SavedReportDefinition} */
    Definition;
}
export class ReportDefinitionCreateRequest {
    /** @param {{Name?:string,Folder?:string,Kind?:string,ChartType?:string,DefinitionJson?:string,IsShared?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Folder;
    /** @type {string} */
    Kind;
    /** @type {string} */
    ChartType;
    /** @type {string} */
    DefinitionJson;
    /** @type {boolean} */
    IsShared;
}

JavaScript ReportDefinitionCreateRequest DTOs

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

HTTP + CSV

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

POST /v1/report/definitions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Name":"String","Folder":"String","Kind":"String","ChartType":"String","DefinitionJson":"String","IsShared":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Definition":{"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"}}