Trendsic Platform Service

<back to all web services

ReportRunRequest

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReportRunRequest extends ReportDefinition
    {
        
    }

    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; }
    }

    public static class ReportRunResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ReportRunResult Result = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReportRunResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ReportRunResult getResult() { return Result; }
        public ReportRunResponse setResult(ReportRunResult value) { this.Result = value; return this; }
    }

    public static class ReportRunResult
    {
        public ArrayList<ReportColumnMeta> Columns = new ArrayList<ReportColumnMeta>();
        public ArrayList<HashMap<String,Object>> Rows = new ArrayList<HashMap<String,Object>>();
        public Integer RowCount = null;
        public Boolean Truncated = null;
        public ArrayList<String> Notes = new ArrayList<String>();
        
        public ArrayList<ReportColumnMeta> getColumns() { return Columns; }
        public ReportRunResult setColumns(ArrayList<ReportColumnMeta> value) { this.Columns = value; return this; }
        public ArrayList<HashMap<String,Object>> getRows() { return Rows; }
        public ReportRunResult setRows(ArrayList<HashMap<String,Object>> value) { this.Rows = value; return this; }
        public Integer getRowCount() { return RowCount; }
        public ReportRunResult setRowCount(Integer value) { this.RowCount = value; return this; }
        public Boolean isTruncated() { return Truncated; }
        public ReportRunResult setTruncated(Boolean value) { this.Truncated = value; return this; }
        public ArrayList<String> getNotes() { return Notes; }
        public ReportRunResult setNotes(ArrayList<String> value) { this.Notes = value; return this; }
    }

    public static class ReportColumnMeta
    {
        public String Code = null;
        public String Name = null;
        public String DataType = null;
        public String FieldKind = null;
        public String Agg = null;
        
        public String getCode() { return Code; }
        public ReportColumnMeta setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public ReportColumnMeta setName(String value) { this.Name = value; return this; }
        public String getDataType() { return DataType; }
        public ReportColumnMeta setDataType(String value) { this.DataType = value; return this; }
        public String getFieldKind() { return FieldKind; }
        public ReportColumnMeta setFieldKind(String value) { this.FieldKind = value; return this; }
        public String getAgg() { return Agg; }
        public ReportColumnMeta setAgg(String value) { this.Agg = value; return this; }
    }

}

Java ReportRunRequest DTOs

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

{
	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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	{
		Columns: 
		[
			{
				Code: String,
				Name: String,
				DataType: String,
				FieldKind: String,
				Agg: String
			}
		],
		Rows: 
		[
			{
				String: {}
			}
		],
		RowCount: 0,
		Truncated: False,
		Notes: 
		[
			String
		]
	}
}