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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineHealthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AffectedRuns>0</AffectedRuns>
  <ByVertical>
    <WorkflowVerticalHealthView>
      <Fail30>0</Fail30>
      <Runs30>0</Runs30>
      <Vertical>String</Vertical>
      <Waiting>0</Waiting>
      <Workflows>0</Workflows>
    </WorkflowVerticalHealthView>
  </ByVertical>
  <Failed30>0</Failed30>
  <OpenErrorGroups>0</OpenErrorGroups>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Runs30>0</Runs30>
  <SlaBreaches>0</SlaBreaches>
  <Succeeded30>0</Succeeded30>
  <Throughput>
    <WorkflowThroughputView>
      <Failed>0</Failed>
      <Hour>0</Hour>
      <Ok>0</Ok>
    </WorkflowThroughputView>
  </Throughput>
  <Waiting>0</Waiting>
</EngineHealthResponse>