Trendsic Platform Service

EngineRunsRequest

The following routes are available for this service:
GET,OPTIONS	/v1/engine/runs

"use strict";
export class WorkflowRunStepView {
    /** @param {{StepId?:number,NodeId?:string,Name?:string,Kind?:string,Status?:string,DurationMs?:number,Input?:string,Output?:string,Note?:string,BranchReason?:string,Attempts?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StepId;
    /** @type {string} */
    NodeId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Status;
    /** @type {number} */
    DurationMs;
    /** @type {string} */
    Input;
    /** @type {string} */
    Output;
    /** @type {string} */
    Note;
    /** @type {string} */
    BranchReason;
    /** @type {number} */
    Attempts;
}
export class WorkflowRunView {
    /** @param {{RunId?:number,RunKey?:string,WorkflowId?:number,WorkflowName?:string,VersionNum?:number,Status?:string,RecordLabel?:string,RecordHref?:string,WaitReason?:string,RunAfter?:string,Attempts?:number,MaxAttempts?:number,StartedAt?:string,FinishedAt?:string,DurationMs?:number,Steps?:WorkflowRunStepView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RunId;
    /** @type {string} */
    RunKey;
    /** @type {number} */
    WorkflowId;
    /** @type {string} */
    WorkflowName;
    /** @type {number} */
    VersionNum;
    /** @type {string} */
    Status;
    /** @type {string} */
    RecordLabel;
    /** @type {string} */
    RecordHref;
    /** @type {string} */
    WaitReason;
    /** @type {?string} */
    RunAfter;
    /** @type {number} */
    Attempts;
    /** @type {number} */
    MaxAttempts;
    /** @type {string} */
    StartedAt;
    /** @type {?string} */
    FinishedAt;
    /** @type {number} */
    DurationMs;
    /** @type {WorkflowRunStepView[]} */
    Steps = [];
}
export class EngineRunsResponse {
    /** @param {{Runs?:WorkflowRunView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowRunView[]} */
    Runs = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineRunsRequest {
    /** @param {{Status?:string,WorkflowId?:number,Top?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Status;
    /** @type {number} */
    WorkflowId;
    /** @type {number} */
    Top;
}

JavaScript EngineRunsRequest 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/engine/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Runs: 
	[
		{
			RunId: 0,
			RunKey: String,
			WorkflowId: 0,
			WorkflowName: String,
			VersionNum: 0,
			Status: String,
			RecordLabel: String,
			RecordHref: String,
			WaitReason: String,
			RunAfter: 0001-01-01,
			Attempts: 0,
			MaxAttempts: 0,
			StartedAt: 0001-01-01,
			FinishedAt: 0001-01-01,
			DurationMs: 0,
			Steps: 
			[
				{
					StepId: 0,
					NodeId: String,
					Name: String,
					Kind: String,
					Status: String,
					DurationMs: 0,
					Input: String,
					Output: String,
					Note: String,
					BranchReason: String,
					Attempts: 0
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}