Trendsic Platform Service

<back to all web services

ReportDefinitionCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/definitions
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 SavedReportDefinition() = 
        member val ReportDefinitionID:Int32 = new Int32() with get,set
        member val ReportDefinitionUID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Folder:String = null with get,set
        member val Kind:String = null with get,set
        member val ChartType:String = null with get,set
        member val DefinitionJson:String = null with get,set
        member val IsShared:Boolean = new Boolean() with get,set
        member val IsSystem:Boolean = new Boolean() with get,set
        member val OwnerUserId:String = null with get,set
        member val IsMine:Boolean = new Boolean() with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ReportDefinitionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Definition:SavedReportDefinition = null with get,set

    [<AllowNullLiteral>]
    type ReportDefinitionCreateRequest() = 
        member val Name:String = null with get,set
        member val Folder:String = null with get,set
        member val Kind:String = null with get,set
        member val ChartType:String = null with get,set
        member val DefinitionJson:String = null with get,set
        member val IsShared:Boolean = new Boolean() with get,set

F# ReportDefinitionCreateRequest 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.

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

{
	Name: String,
	Folder: String,
	Kind: String,
	ChartType: String,
	DefinitionJson: String,
	IsShared: False
}
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
		}
	},
	Definition: 
	{
		ReportDefinitionID: 0,
		ReportDefinitionUID: 00000000000000000000000000000000,
		Name: String,
		Folder: String,
		Kind: String,
		ChartType: String,
		DefinitionJson: String,
		IsShared: False,
		IsSystem: False,
		OwnerUserId: String,
		IsMine: False,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	}
}