Trendsic Platform Service

<back to all web services

ReportDefinitionVersionSetStatusRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/definitions/{Uid}/versions/{Number}/status
"use strict";
export class ReportDefinitionVersion {
    /** @param {{Id?:number,ReportDefinitionID?:number,VersionNumber?:number,DefinitionJson?:string,Status?:string,Note?:string,CreatedBy?:string,CreatedAt?:string,IsMine?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    ReportDefinitionID;
    /** @type {number} */
    VersionNumber;
    /** @type {string} */
    DefinitionJson;
    /** @type {string} */
    Status;
    /** @type {string} */
    Note;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {boolean} */
    IsMine;
}
export class ReportDefinitionVersionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Version?:ReportDefinitionVersion}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ReportDefinitionVersion} */
    Version;
}
export class ReportDefinitionVersionSetStatusRequest {
    /** @param {{Uid?:string,Number?:number,Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Uid;
    /** @type {number} */
    Number;
    /** @type {string} */
    Status;
}

JavaScript ReportDefinitionVersionSetStatusRequest 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/{Number}/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Uid: 00000000000000000000000000000000,
	Number: 0,
	Status: 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
	}
}