Trendsic Platform Service

<back to all web services

MessagingWorkflowActionRequest

Requires Authentication
The following routes are available for this service:
POST/v1/messaging/workflows/{WorkflowId}/replace
POST/v1/messaging/workflows/{WorkflowId}/keep
"use strict";
export class CompileResult {
    /** @param {{RuleKey?:string,BranchId?:string,LineId?:string,StepId?:string,WorkflowId?:number,VersionNum?:number,Action?:string,Name?:string,Note?:string,Customized?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RuleKey;
    /** @type {string} */
    BranchId;
    /** @type {?string} */
    LineId;
    /** @type {string} */
    StepId;
    /** @type {?number} */
    WorkflowId;
    /** @type {?number} */
    VersionNum;
    /** @type {string} */
    Action;
    /** @type {string} */
    Name;
    /** @type {string} */
    Note;
    /** @type {boolean} */
    Customized;
}
export class MessagingCompileResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Results?:CompileResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CompileResult[]} */
    Results = [];
}
export class MessagingWorkflowActionRequest {
    /** @param {{WorkflowId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
}

JavaScript MessagingWorkflowActionRequest 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/messaging/workflows/{WorkflowId}/replace HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WorkflowId: 0
}
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
		}
	},
	Results: 
	[
		{
			RuleKey: String,
			BranchId: 00000000000000000000000000000000,
			LineId: 00000000000000000000000000000000,
			StepId: String,
			WorkflowId: 0,
			VersionNum: 0,
			Action: String,
			Name: String,
			Note: String,
			Customized: False
		}
	]
}