Trendsic Platform Service

<back to all web services

EngineHealthRequest

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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class EngineHealthRequest
    {
    }

    public partial class EngineHealthResponse
    {
        public virtual int Runs30 { get; set; }
        public virtual int Succeeded30 { get; set; }
        public virtual int Failed30 { get; set; }
        public virtual int Waiting { get; set; }
        public virtual int OpenErrorGroups { get; set; }
        public virtual int AffectedRuns { get; set; }
        public virtual int SlaBreaches { get; set; }
        public virtual List<WorkflowThroughputView> Throughput { get; set; } = [];
        public virtual List<WorkflowVerticalHealthView> ByVertical { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class WorkflowThroughputView
    {
        public virtual int Hour { get; set; }
        public virtual int Ok { get; set; }
        public virtual int Failed { get; set; }
    }

    public partial class WorkflowVerticalHealthView
    {
        public virtual string Vertical { get; set; }
        public virtual int Workflows { get; set; }
        public virtual int Runs30 { get; set; }
        public virtual int Fail30 { get; set; }
        public virtual int Waiting { get; set; }
    }

}

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