Trendsic Platform Service

<back to all web services

EngineHealthRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/health

export class WorkflowThroughputView
{
    public Hour: number;
    public Ok: number;
    public Failed: number;

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

export class WorkflowVerticalHealthView
{
    public Vertical: string;
    public Workflows: number;
    public Runs30: number;
    public Fail30: number;
    public Waiting: number;

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

export class EngineHealthResponse
{
    public Runs30: number;
    public Succeeded30: number;
    public Failed30: number;
    public Waiting: number;
    public OpenErrorGroups: number;
    public AffectedRuns: number;
    public SlaBreaches: number;
    public Throughput: WorkflowThroughputView[] = [];
    public ByVertical: WorkflowVerticalHealthView[] = [];
    public ResponseStatus: ResponseStatus;

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

export class EngineHealthRequest
{

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

TypeScript EngineHealthRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}