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}
ReportDatasetRequest Parameters:
NameParameterData TypeRequiredDescription
DatasetCodepathstringNo
ReportDatasetResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DatasetformReportDatasetDtoNo
ReportDatasetDto Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
DescriptionformstringNo
FieldsformList<ReportFieldDto>No
JoinsformList<ReportJoinDto>No
ReportFieldDto Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
FieldKindformstringNo
DataTypeformstringNo
DefaultAggregationformstringNo
ReportJoinDto Parameters:
NameParameterData TypeRequiredDescription
ToDatasetCodeformstringNo
ToDatasetNameformstringNo
CardinalityformstringNo
JoinTypeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}}