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

export class SavedReportDefinition
{
    public ReportDefinitionID: number;
    public ReportDefinitionUID: string;
    public Name: string;
    public Folder: string;
    public Kind: string;
    public ChartType: string;
    public DefinitionJson: string;
    public IsShared: boolean;
    public IsSystem: boolean;
    public OwnerUserId: string;
    public IsMine: boolean;
    public CreatedAt?: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<SavedReportDefinition>) { (Object as any).assign(this, init); }
}

export class ReportDefinitionResponse
{
    public ResponseStatus: ResponseStatus;
    public Definition: SavedReportDefinition;

    public constructor(init?: Partial<ReportDefinitionResponse>) { (Object as any).assign(this, init); }
}

export class ReportDefinitionCreateRequest
{
    public Name: string;
    public Folder: string;
    public Kind: string;
    public ChartType: string;
    public DefinitionJson: string;
    public IsShared: boolean;

    public constructor(init?: Partial<ReportDefinitionCreateRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}