Trendsic Platform Service

<back to all web services

EngineHealthRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/health
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowThroughputView:
    hour: int = 0
    ok: int = 0
    failed: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowVerticalHealthView:
    vertical: Optional[str] = None
    workflows: int = 0
    runs30: int = 0
    fail30: int = 0
    waiting: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineHealthResponse:
    runs30: int = 0
    succeeded30: int = 0
    failed30: int = 0
    waiting: int = 0
    open_error_groups: int = 0
    affected_runs: int = 0
    sla_breaches: int = 0
    throughput: List[WorkflowThroughputView] = field(default_factory=list)
    by_vertical: List[WorkflowVerticalHealthView] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineHealthRequest:
    pass

Python EngineHealthRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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