Trendsic Platform Service

<back to all web services

EngineHealthRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/health
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class EngineHealthRequest
        End Class

        Public Partial Class EngineHealthResponse
            Public Overridable Property Runs30 As Integer
            Public Overridable Property Succeeded30 As Integer
            Public Overridable Property Failed30 As Integer
            Public Overridable Property Waiting As Integer
            Public Overridable Property OpenErrorGroups As Integer
            Public Overridable Property AffectedRuns As Integer
            Public Overridable Property SlaBreaches As Integer
            Public Overridable Property Throughput As List(Of WorkflowThroughputView) = New List(Of WorkflowThroughputView)
            Public Overridable Property ByVertical As List(Of WorkflowVerticalHealthView) = New List(Of WorkflowVerticalHealthView)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class WorkflowThroughputView
            Public Overridable Property Hour As Integer
            Public Overridable Property Ok As Integer
            Public Overridable Property Failed As Integer
        End Class

        Public Partial Class WorkflowVerticalHealthView
            Public Overridable Property Vertical As String
            Public Overridable Property Workflows As Integer
            Public Overridable Property Runs30 As Integer
            Public Overridable Property Fail30 As Integer
            Public Overridable Property Waiting As Integer
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}