Trendsic Platform Service

<back to all web services

ReportDatasetsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/report/datasets

export class ReportFieldDto
{
    public Code: string;
    public Name: string;
    public FieldKind: string;
    public DataType: string;
    public DefaultAggregation: string;

    public constructor(init?: Partial<ReportFieldDto>) { (Object as any).assign(this, init); }
}

export class ReportJoinDto
{
    public ToDatasetCode: string;
    public ToDatasetName: string;
    public Cardinality: string;
    public JoinType: string;

    public constructor(init?: Partial<ReportJoinDto>) { (Object as any).assign(this, init); }
}

export class ReportDatasetDto
{
    public Code: string;
    public Name: string;
    public Description: string;
    public Fields: ReportFieldDto[] = [];
    public Joins: ReportJoinDto[] = [];

    public constructor(init?: Partial<ReportDatasetDto>) { (Object as any).assign(this, init); }
}

export class ReportDatasetsResponse
{
    public ResponseStatus: ResponseStatus;
    public Datasets: ReportDatasetDto[] = [];

    public constructor(init?: Partial<ReportDatasetsResponse>) { (Object as any).assign(this, init); }
}

export class ReportDatasetsRequest
{

    public constructor(init?: Partial<ReportDatasetsRequest>) { (Object as any).assign(this, init); }
}

TypeScript ReportDatasetsRequest 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 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
		}
	},
	Datasets: 
	[
		{
			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
				}
			]
		}
	]
}