Trendsic Platform Service

<back to all web services

EngineHealthRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/health
"use strict";
export class WorkflowThroughputView {
    /** @param {{Hour?:number,Ok?:number,Failed?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Hour;
    /** @type {number} */
    Ok;
    /** @type {number} */
    Failed;
}
export class WorkflowVerticalHealthView {
    /** @param {{Vertical?:string,Workflows?:number,Runs30?:number,Fail30?:number,Waiting?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Vertical;
    /** @type {number} */
    Workflows;
    /** @type {number} */
    Runs30;
    /** @type {number} */
    Fail30;
    /** @type {number} */
    Waiting;
}
export class EngineHealthResponse {
    /** @param {{Runs30?:number,Succeeded30?:number,Failed30?:number,Waiting?:number,OpenErrorGroups?:number,AffectedRuns?:number,SlaBreaches?:number,Throughput?:WorkflowThroughputView[],ByVertical?:WorkflowVerticalHealthView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Runs30;
    /** @type {number} */
    Succeeded30;
    /** @type {number} */
    Failed30;
    /** @type {number} */
    Waiting;
    /** @type {number} */
    OpenErrorGroups;
    /** @type {number} */
    AffectedRuns;
    /** @type {number} */
    SlaBreaches;
    /** @type {WorkflowThroughputView[]} */
    Throughput = [];
    /** @type {WorkflowVerticalHealthView[]} */
    ByVertical = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineHealthRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript EngineHealthRequest 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/health HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Runs30: 0,
	Succeeded30: 0,
	Failed30: 0,
	Waiting: 0,
	OpenErrorGroups: 0,
	AffectedRuns: 0,
	SlaBreaches: 0,
	Throughput: 
	[
		{
			Hour: 0,
			Ok: 0,
			Failed: 0
		}
	],
	ByVertical: 
	[
		{
			Vertical: String,
			Workflows: 0,
			Runs30: 0,
			Fail30: 0,
			Waiting: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}