Trendsic Platform Service

<back to all web services

EngineHealthRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/health
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowThroughputView() = 
        member val Hour:Int32 = new Int32() with get,set
        member val Ok:Int32 = new Int32() with get,set
        member val Failed:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type WorkflowVerticalHealthView() = 
        member val Vertical:String = null with get,set
        member val Workflows:Int32 = new Int32() with get,set
        member val Runs30:Int32 = new Int32() with get,set
        member val Fail30:Int32 = new Int32() with get,set
        member val Waiting:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type EngineHealthResponse() = 
        member val Runs30:Int32 = new Int32() with get,set
        member val Succeeded30:Int32 = new Int32() with get,set
        member val Failed30:Int32 = new Int32() with get,set
        member val Waiting:Int32 = new Int32() with get,set
        member val OpenErrorGroups:Int32 = new Int32() with get,set
        member val AffectedRuns:Int32 = new Int32() with get,set
        member val SlaBreaches:Int32 = new Int32() with get,set
        member val Throughput:ResizeArray<WorkflowThroughputView> = new ResizeArray<WorkflowThroughputView>() with get,set
        member val ByVertical:ResizeArray<WorkflowVerticalHealthView> = new ResizeArray<WorkflowVerticalHealthView>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type EngineHealthRequest() = 
        class end

F# 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"}}}