| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/report/export |
|---|
"use strict";
export class ReportMeasure {
/** @param {{FieldCode?:string,Agg?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FieldCode;
/** @type {string} */
Agg;
}
export class ReportSort {
/** @param {{FieldCode?:string,Dir?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FieldCode;
/** @type {string} */
Dir;
}
export class ReportDefinition {
/** @param {{DatasetCode?:string,Dimensions?:string[],Measures?:ReportMeasure[],Joins?:string[],Filters?:string,Sorts?:ReportSort[],Limit?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
DatasetCode;
/** @type {string[]} */
Dimensions = [];
/** @type {ReportMeasure[]} */
Measures = [];
/** @type {string[]} */
Joins = [];
/** @type {string} */
Filters;
/** @type {ReportSort[]} */
Sorts = [];
/** @type {number} */
Limit;
}
export class ReportExportRequest extends ReportDefinition {
/** @param {{Format?:string,Title?:string,FileName?:string,DatasetCode?:string,Dimensions?:string[],Measures?:ReportMeasure[],Joins?:string[],Filters?:string,Sorts?:ReportSort[],Limit?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Format;
/** @type {string} */
Title;
/** @type {string} */
FileName;
}
JavaScript ReportExportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/report/export HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Format: String,
Title: String,
FileName: String,
DatasetCode: String,
Dimensions:
[
String
],
Measures:
[
{
FieldCode: String,
Agg: String
}
],
Joins:
[
String
],
Filters: String,
Sorts:
[
{
FieldCode: String,
Dir: String
}
],
Limit: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length (byte[])