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.*


open class ReportDatasetRequest
{
    open var DatasetCode:String? = null
}

open class ReportDatasetResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Dataset:ReportDatasetDto? = null
}

open class ReportDatasetDto
{
    open var Code:String? = null
    open var Name:String? = null
    open var Description:String? = null
    open var Fields:ArrayList<ReportFieldDto> = ArrayList<ReportFieldDto>()
    open var Joins:ArrayList<ReportJoinDto> = ArrayList<ReportJoinDto>()
}

open class ReportFieldDto
{
    open var Code:String? = null
    open var Name:String? = null
    open var FieldKind:String? = null
    open var DataType:String? = null
    open var DefaultAggregation:String? = null
}

open class ReportJoinDto
{
    open var ToDatasetCode:String? = null
    open var ToDatasetName:String? = null
    open var Cardinality:String? = null
    open var JoinType:String? = null
}

Kotlin 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
			}
		]
	}
}