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}

"use strict";
export class ReportFieldDto {
    /** @param {{Code?:string,Name?:string,FieldKind?:string,DataType?:string,DefaultAggregation?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    FieldKind;
    /** @type {string} */
    DataType;
    /** @type {string} */
    DefaultAggregation;
}
export class ReportJoinDto {
    /** @param {{ToDatasetCode?:string,ToDatasetName?:string,Cardinality?:string,JoinType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ToDatasetCode;
    /** @type {string} */
    ToDatasetName;
    /** @type {string} */
    Cardinality;
    /** @type {string} */
    JoinType;
}
export class ReportDatasetDto {
    /** @param {{Code?:string,Name?:string,Description?:string,Fields?:ReportFieldDto[],Joins?:ReportJoinDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {ReportFieldDto[]} */
    Fields = [];
    /** @type {ReportJoinDto[]} */
    Joins = [];
}
export class ReportDatasetResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Dataset?:ReportDatasetDto}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ReportDatasetDto} */
    Dataset;
}
export class ReportDatasetRequest {
    /** @param {{DatasetCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DatasetCode;
}

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