Trendsic Platform Service

<back to all web services

ReportExportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ReportExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DatasetCode>String</DatasetCode>
  <Dimensions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Dimensions>
  <Filters>String</Filters>
  <Joins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Joins>
  <Limit>0</Limit>
  <Measures>
    <ReportMeasure>
      <Agg>String</Agg>
      <FieldCode>String</FieldCode>
    </ReportMeasure>
  </Measures>
  <Sorts>
    <ReportSort>
      <Dir>String</Dir>
      <FieldCode>String</FieldCode>
    </ReportSort>
  </Sorts>
  <FileName>String</FileName>
  <Format>String</Format>
  <Title>String</Title>
</ReportExportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

(byte[])