Trendsic Platform Service

ReportRunRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/report/run

**ReportDefinition** Parameters:
Name	Parameter	Data Type	Required
DatasetCode	form	string	No
Dimensions	form	List<string>	No
Measures	form	List<ReportMeasure>	No
Joins	form	List<string>	No
Filters	form	string	No
Sorts	form	List<ReportSort>	No
Limit	form	int	No

**ReportMeasure** Parameters:
Name	Parameter	Data Type	Required	Description
FieldCode	form	string	No
Agg	form	string	No

**ReportSort** Parameters:
Name	Parameter	Data Type	Required	Description
FieldCode	form	string	No
Dir	form	string	No

**ReportRunResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Result	form	ReportRunResult	No

**ReportRunResult** Parameters:
Name	Parameter	Data Type	Required
Columns	form	List<ReportColumnMeta>	No
Rows	form	List<Dictionary<String,Object>>	No
RowCount	form	int	No
Truncated	form	bool	No
Notes	form	List<string>	No

**ReportColumnMeta** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
DataType	form	string	No
FieldKind	form	string	No
Agg	form	string	No

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.

POST /v1/report/run HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DatasetCode: String,
	Dimensions: 
	[
		String
	],
	Measures: 
	[
		{
			FieldCode: String,
			Agg: String
		}
	],
	Joins: 
	[
		String
	],
	Filters: String,
	Sorts: 
	[
		{
			FieldCode: String,
			Dir: String
		}
	],
	Limit: 0
}

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
		}
	},
	Result: 
	{
		Columns: 
		[
			{
				Code: String,
				Name: String,
				DataType: String,
				FieldKind: String,
				Agg: String
			}
		],
		Rows: 
		[
			{
				String: {}
			}
		],
		RowCount: 0,
		Truncated: False,
		Notes: 
		[
			String
		]
	}
}