Trendsic Platform Service

ReportDefinitionGetRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/report/definitions/{Uid}

"use strict";
export class SavedReportDefinition {
    /** @param {{ReportDefinitionID?:number,ReportDefinitionUID?:string,Name?:string,Folder?:string,Kind?:string,ChartType?:string,DefinitionJson?:string,IsShared?:boolean,IsSystem?:boolean,OwnerUserId?:string,IsMine?:boolean,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ReportDefinitionID;
    /** @type {string} */
    ReportDefinitionUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Folder;
    /** @type {string} */
    Kind;
    /** @type {string} */
    ChartType;
    /** @type {string} */
    DefinitionJson;
    /** @type {boolean} */
    IsShared;
    /** @type {boolean} */
    IsSystem;
    /** @type {string} */
    OwnerUserId;
    /** @type {boolean} */
    IsMine;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ReportDefinitionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Definition?:SavedReportDefinition}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SavedReportDefinition} */
    Definition;
}
export class ReportDefinitionGetRequest {
    /** @param {{Uid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Uid;
}

JavaScript ReportDefinitionGetRequest 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/definitions/{Uid} 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
		}
	},
	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
	}
}