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
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 ReportFieldDto() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val FieldKind:String = null with get,set
        member val DataType:String = null with get,set
        member val DefaultAggregation:String = null with get,set

    [<AllowNullLiteral>]
    type ReportJoinDto() = 
        member val ToDatasetCode:String = null with get,set
        member val ToDatasetName:String = null with get,set
        member val Cardinality:String = null with get,set
        member val JoinType:String = null with get,set

    [<AllowNullLiteral>]
    type ReportDatasetDto() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Fields:ResizeArray<ReportFieldDto> = new ResizeArray<ReportFieldDto>() with get,set
        member val Joins:ResizeArray<ReportJoinDto> = new ResizeArray<ReportJoinDto>() with get,set

    [<AllowNullLiteral>]
    type ReportDatasetsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Datasets:ResizeArray<ReportDatasetDto> = new ResizeArray<ReportDatasetDto>() with get,set

    [<AllowNullLiteral>]
    type ReportDatasetsRequest() = 
        class end

F# 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
				}
			]
		}
	]
}