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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReportExportRequest extends ReportDefinition
    {
        public String Format = null;
        public String Title = null;
        public String FileName = null;
        
        public String getFormat() { return Format; }
        public ReportExportRequest setFormat(String value) { this.Format = value; return this; }
        public String getTitle() { return Title; }
        public ReportExportRequest setTitle(String value) { this.Title = value; return this; }
        public String getFileName() { return FileName; }
        public ReportExportRequest setFileName(String value) { this.FileName = value; return this; }
    }

    public static class ReportDefinition
    {
        public String DatasetCode = null;
        public ArrayList<String> Dimensions = new ArrayList<String>();
        public ArrayList<ReportMeasure> Measures = new ArrayList<ReportMeasure>();
        public ArrayList<String> Joins = new ArrayList<String>();
        public String Filters = null;
        public ArrayList<ReportSort> Sorts = new ArrayList<ReportSort>();
        public Integer Limit = null;
        
        public String getDatasetCode() { return DatasetCode; }
        public ReportDefinition setDatasetCode(String value) { this.DatasetCode = value; return this; }
        public ArrayList<String> getDimensions() { return Dimensions; }
        public ReportDefinition setDimensions(ArrayList<String> value) { this.Dimensions = value; return this; }
        public ArrayList<ReportMeasure> getMeasures() { return Measures; }
        public ReportDefinition setMeasures(ArrayList<ReportMeasure> value) { this.Measures = value; return this; }
        public ArrayList<String> getJoins() { return Joins; }
        public ReportDefinition setJoins(ArrayList<String> value) { this.Joins = value; return this; }
        public String getFilters() { return Filters; }
        public ReportDefinition setFilters(String value) { this.Filters = value; return this; }
        public ArrayList<ReportSort> getSorts() { return Sorts; }
        public ReportDefinition setSorts(ArrayList<ReportSort> value) { this.Sorts = value; return this; }
        public Integer getLimit() { return Limit; }
        public ReportDefinition setLimit(Integer value) { this.Limit = value; return this; }
    }

    public static class ReportMeasure
    {
        public String FieldCode = null;
        public String Agg = null;
        
        public String getFieldCode() { return FieldCode; }
        public ReportMeasure setFieldCode(String value) { this.FieldCode = value; return this; }
        public String getAgg() { return Agg; }
        public ReportMeasure setAgg(String value) { this.Agg = value; return this; }
    }

    public static class ReportSort
    {
        public String FieldCode = null;
        public String Dir = null;
        
        public String getFieldCode() { return FieldCode; }
        public ReportSort setFieldCode(String value) { this.FieldCode = value; return this; }
        public String getDir() { return Dir; }
        public ReportSort setDir(String value) { this.Dir = value; return this; }
    }

}

Java 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[])