| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/report/run |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ReportColumnMeta() =
member val Code:String = null with get,set
member val Name:String = null with get,set
member val DataType:String = null with get,set
member val FieldKind:String = null with get,set
member val Agg:String = null with get,set
[<AllowNullLiteral>]
type ReportRunResult() =
member val Columns:ResizeArray<ReportColumnMeta> = new ResizeArray<ReportColumnMeta>() with get,set
member val Rows:ResizeArray<Dictionary<String,Object>> = new ResizeArray<Dictionary<String,Object>>() with get,set
member val RowCount:Int32 = new Int32() with get,set
member val Truncated:Boolean = new Boolean() with get,set
member val Notes:ResizeArray<String> = new ResizeArray<String>() with get,set
[<AllowNullLiteral>]
type ReportRunResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Result:ReportRunResult = null with get,set
[<AllowNullLiteral>]
type ReportMeasure() =
member val FieldCode:String = null with get,set
member val Agg:String = null with get,set
[<AllowNullLiteral>]
type ReportSort() =
member val FieldCode:String = null with get,set
member val Dir:String = null with get,set
[<AllowNullLiteral>]
type ReportDefinition() =
member val DatasetCode:String = null with get,set
member val Dimensions:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Measures:ResizeArray<ReportMeasure> = new ResizeArray<ReportMeasure>() with get,set
member val Joins:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Filters:String = null with get,set
member val Sorts:ResizeArray<ReportSort> = new ResizeArray<ReportSort>() with get,set
member val Limit:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ReportRunRequest() =
inherit ReportDefinition()
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.
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
]
}
}