Trendsic Platform Service

<back to all web services

ReportDefinitionVersionCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/definitions/{Uid}/versions

export class ReportDefinitionVersion
{
    public Id: number;
    public ReportDefinitionID: number;
    public VersionNumber: number;
    public DefinitionJson: string;
    public Status: string;
    public Note: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public IsMine: boolean;

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

export class ReportDefinitionVersionResponse
{
    public ResponseStatus: ResponseStatus;
    public Version: ReportDefinitionVersion;

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

export class ReportDefinitionVersionCreateRequest
{
    public Uid: string;
    public Note: string;

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

TypeScript ReportDefinitionVersionCreateRequest 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/{Uid}/versions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Uid: 00000000000000000000000000000000,
	Note: String
}
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
		}
	},
	Version: 
	{
		Id: 0,
		ReportDefinitionID: 0,
		VersionNumber: 0,
		DefinitionJson: String,
		Status: String,
		Note: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		IsMine: False
	}
}