Trendsic Platform Service

<back to all web services

ReportDatasetRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/datasets/{DatasetCode}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReportDatasetRequest
    {
        public String DatasetCode = null;
        
        public String getDatasetCode() { return DatasetCode; }
        public ReportDatasetRequest setDatasetCode(String value) { this.DatasetCode = value; return this; }
    }

    public static class ReportDatasetResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ReportDatasetDto Dataset = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReportDatasetResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ReportDatasetDto getDataset() { return Dataset; }
        public ReportDatasetResponse setDataset(ReportDatasetDto value) { this.Dataset = value; return this; }
    }

    public static class ReportDatasetDto
    {
        public String Code = null;
        public String Name = null;
        public String Description = null;
        public ArrayList<ReportFieldDto> Fields = new ArrayList<ReportFieldDto>();
        public ArrayList<ReportJoinDto> Joins = new ArrayList<ReportJoinDto>();
        
        public String getCode() { return Code; }
        public ReportDatasetDto setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public ReportDatasetDto setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ReportDatasetDto setDescription(String value) { this.Description = value; return this; }
        public ArrayList<ReportFieldDto> getFields() { return Fields; }
        public ReportDatasetDto setFields(ArrayList<ReportFieldDto> value) { this.Fields = value; return this; }
        public ArrayList<ReportJoinDto> getJoins() { return Joins; }
        public ReportDatasetDto setJoins(ArrayList<ReportJoinDto> value) { this.Joins = value; return this; }
    }

    public static class ReportFieldDto
    {
        public String Code = null;
        public String Name = null;
        public String FieldKind = null;
        public String DataType = null;
        public String DefaultAggregation = null;
        
        public String getCode() { return Code; }
        public ReportFieldDto setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public ReportFieldDto setName(String value) { this.Name = value; return this; }
        public String getFieldKind() { return FieldKind; }
        public ReportFieldDto setFieldKind(String value) { this.FieldKind = value; return this; }
        public String getDataType() { return DataType; }
        public ReportFieldDto setDataType(String value) { this.DataType = value; return this; }
        public String getDefaultAggregation() { return DefaultAggregation; }
        public ReportFieldDto setDefaultAggregation(String value) { this.DefaultAggregation = value; return this; }
    }

    public static class ReportJoinDto
    {
        public String ToDatasetCode = null;
        public String ToDatasetName = null;
        public String Cardinality = null;
        public String JoinType = null;
        
        public String getToDatasetCode() { return ToDatasetCode; }
        public ReportJoinDto setToDatasetCode(String value) { this.ToDatasetCode = value; return this; }
        public String getToDatasetName() { return ToDatasetName; }
        public ReportJoinDto setToDatasetName(String value) { this.ToDatasetName = value; return this; }
        public String getCardinality() { return Cardinality; }
        public ReportJoinDto setCardinality(String value) { this.Cardinality = value; return this; }
        public String getJoinType() { return JoinType; }
        public ReportJoinDto setJoinType(String value) { this.JoinType = value; return this; }
    }

}

Java ReportDatasetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/report/datasets/{DatasetCode} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Dataset: 
	{
		Code: String,
		Name: String,
		Description: String,
		Fields: 
		[
			{
				Code: String,
				Name: String,
				FieldKind: String,
				DataType: String,
				DefaultAggregation: String
			}
		],
		Joins: 
		[
			{
				ToDatasetCode: String,
				ToDatasetName: String,
				Cardinality: String,
				JoinType: String
			}
		]
	}
}