| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/report/datasets/{DatasetCode} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DatasetCode | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Dataset | form | ReportDatasetDto | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Fields | form | List<ReportFieldDto> | No | |
| Joins | form | List<ReportJoinDto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| FieldKind | form | string | No | |
| DataType | form | string | No | |
| DefaultAggregation | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ToDatasetCode | form | string | No | |
| ToDatasetName | form | string | No | |
| Cardinality | form | string | No | |
| JoinType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}
}