Trendsic Platform Service

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 Foundation
import ServiceStack

public class ReportDatasetRequest : Codable
{
    public var datasetCode:String

    required public init(){}
}

public class ReportDatasetResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var dataset:ReportDatasetDto

    required public init(){}
}

public class ReportDatasetDto : Codable
{
    public var code:String
    public var name:String
    public var Description:String
    public var fields:[ReportFieldDto] = []
    public var joins:[ReportJoinDto] = []

    required public init(){}
}

public class ReportFieldDto : Codable
{
    public var code:String
    public var name:String
    public var fieldKind:String
    public var dataType:String
    public var defaultAggregation:String

    required public init(){}
}

public class ReportJoinDto : Codable
{
    public var toDatasetCode:String
    public var toDatasetName:String
    public var cardinality:String
    public var joinType:String

    required public init(){}
}

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