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 'package:servicestack/servicestack.dart';

class ReportFieldDto implements IConvertible
{
    String? Code;
    String? Name;
    String? FieldKind;
    String? DataType;
    String? DefaultAggregation;

    ReportFieldDto({this.Code,this.Name,this.FieldKind,this.DataType,this.DefaultAggregation});
    ReportFieldDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        Name = json['Name'];
        FieldKind = json['FieldKind'];
        DataType = json['DataType'];
        DefaultAggregation = json['DefaultAggregation'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'Name': Name,
        'FieldKind': FieldKind,
        'DataType': DataType,
        'DefaultAggregation': DefaultAggregation
    };

    getTypeName() => "ReportFieldDto";
    TypeContext? context = _ctx;
}

class ReportJoinDto implements IConvertible
{
    String? ToDatasetCode;
    String? ToDatasetName;
    String? Cardinality;
    String? JoinType;

    ReportJoinDto({this.ToDatasetCode,this.ToDatasetName,this.Cardinality,this.JoinType});
    ReportJoinDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ToDatasetCode = json['ToDatasetCode'];
        ToDatasetName = json['ToDatasetName'];
        Cardinality = json['Cardinality'];
        JoinType = json['JoinType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ToDatasetCode': ToDatasetCode,
        'ToDatasetName': ToDatasetName,
        'Cardinality': Cardinality,
        'JoinType': JoinType
    };

    getTypeName() => "ReportJoinDto";
    TypeContext? context = _ctx;
}

class ReportDatasetDto implements IConvertible
{
    String? Code;
    String? Name;
    String? Description;
    List<ReportFieldDto>? Fields = [];
    List<ReportJoinDto>? Joins = [];

    ReportDatasetDto({this.Code,this.Name,this.Description,this.Fields,this.Joins});
    ReportDatasetDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        Name = json['Name'];
        Description = json['Description'];
        Fields = JsonConverters.fromJson(json['Fields'],'List<ReportFieldDto>',context!);
        Joins = JsonConverters.fromJson(json['Joins'],'List<ReportJoinDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'Name': Name,
        'Description': Description,
        'Fields': JsonConverters.toJson(Fields,'List<ReportFieldDto>',context!),
        'Joins': JsonConverters.toJson(Joins,'List<ReportJoinDto>',context!)
    };

    getTypeName() => "ReportDatasetDto";
    TypeContext? context = _ctx;
}

class ReportDatasetResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    ReportDatasetDto? Dataset;

    ReportDatasetResponse({this.ResponseStatus,this.Dataset});
    ReportDatasetResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Dataset = JsonConverters.fromJson(json['Dataset'],'ReportDatasetDto',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Dataset': JsonConverters.toJson(Dataset,'ReportDatasetDto',context!)
    };

    getTypeName() => "ReportDatasetResponse";
    TypeContext? context = _ctx;
}

class ReportDatasetRequest implements IConvertible
{
    String? DatasetCode;

    ReportDatasetRequest({this.DatasetCode});
    ReportDatasetRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DatasetCode = json['DatasetCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DatasetCode': DatasetCode
    };

    getTypeName() => "ReportDatasetRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'ReportFieldDto': TypeInfo(TypeOf.Class, create:() => ReportFieldDto()),
    'ReportJoinDto': TypeInfo(TypeOf.Class, create:() => ReportJoinDto()),
    'ReportDatasetDto': TypeInfo(TypeOf.Class, create:() => ReportDatasetDto()),
    'List<ReportFieldDto>': TypeInfo(TypeOf.Class, create:() => <ReportFieldDto>[]),
    'List<ReportJoinDto>': TypeInfo(TypeOf.Class, create:() => <ReportJoinDto>[]),
    'ReportDatasetResponse': TypeInfo(TypeOf.Class, create:() => ReportDatasetResponse()),
    'ReportDatasetRequest': TypeInfo(TypeOf.Class, create:() => ReportDatasetRequest()),
});

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