| Requires any of the roles: | Agent, Administrator |
| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv Content-Length: length (byte[])