Trendsic Platform Service

<back to all web services

EngineHealthRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/health
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class WorkflowThroughputView implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Hour=0,
        /** @var int */
        public int $Ok=0,
        /** @var int */
        public int $Failed=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Hour'])) $this->Hour = $o['Hour'];
        if (isset($o['Ok'])) $this->Ok = $o['Ok'];
        if (isset($o['Failed'])) $this->Failed = $o['Failed'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Hour)) $o['Hour'] = $this->Hour;
        if (isset($this->Ok)) $o['Ok'] = $this->Ok;
        if (isset($this->Failed)) $o['Failed'] = $this->Failed;
        return empty($o) ? new class(){} : $o;
    }
}

class WorkflowVerticalHealthView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Vertical=null,
        /** @var int */
        public int $Workflows=0,
        /** @var int */
        public int $Runs30=0,
        /** @var int */
        public int $Fail30=0,
        /** @var int */
        public int $Waiting=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Vertical'])) $this->Vertical = $o['Vertical'];
        if (isset($o['Workflows'])) $this->Workflows = $o['Workflows'];
        if (isset($o['Runs30'])) $this->Runs30 = $o['Runs30'];
        if (isset($o['Fail30'])) $this->Fail30 = $o['Fail30'];
        if (isset($o['Waiting'])) $this->Waiting = $o['Waiting'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Vertical)) $o['Vertical'] = $this->Vertical;
        if (isset($this->Workflows)) $o['Workflows'] = $this->Workflows;
        if (isset($this->Runs30)) $o['Runs30'] = $this->Runs30;
        if (isset($this->Fail30)) $o['Fail30'] = $this->Fail30;
        if (isset($this->Waiting)) $o['Waiting'] = $this->Waiting;
        return empty($o) ? new class(){} : $o;
    }
}

class EngineHealthResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Runs30=0,
        /** @var int */
        public int $Succeeded30=0,
        /** @var int */
        public int $Failed30=0,
        /** @var int */
        public int $Waiting=0,
        /** @var int */
        public int $OpenErrorGroups=0,
        /** @var int */
        public int $AffectedRuns=0,
        /** @var int */
        public int $SlaBreaches=0,
        /** @var array<WorkflowThroughputView>|null */
        public ?array $Throughput=null,
        /** @var array<WorkflowVerticalHealthView>|null */
        public ?array $ByVertical=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Runs30'])) $this->Runs30 = $o['Runs30'];
        if (isset($o['Succeeded30'])) $this->Succeeded30 = $o['Succeeded30'];
        if (isset($o['Failed30'])) $this->Failed30 = $o['Failed30'];
        if (isset($o['Waiting'])) $this->Waiting = $o['Waiting'];
        if (isset($o['OpenErrorGroups'])) $this->OpenErrorGroups = $o['OpenErrorGroups'];
        if (isset($o['AffectedRuns'])) $this->AffectedRuns = $o['AffectedRuns'];
        if (isset($o['SlaBreaches'])) $this->SlaBreaches = $o['SlaBreaches'];
        if (isset($o['Throughput'])) $this->Throughput = JsonConverters::fromArray('WorkflowThroughputView', $o['Throughput']);
        if (isset($o['ByVertical'])) $this->ByVertical = JsonConverters::fromArray('WorkflowVerticalHealthView', $o['ByVertical']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Runs30)) $o['Runs30'] = $this->Runs30;
        if (isset($this->Succeeded30)) $o['Succeeded30'] = $this->Succeeded30;
        if (isset($this->Failed30)) $o['Failed30'] = $this->Failed30;
        if (isset($this->Waiting)) $o['Waiting'] = $this->Waiting;
        if (isset($this->OpenErrorGroups)) $o['OpenErrorGroups'] = $this->OpenErrorGroups;
        if (isset($this->AffectedRuns)) $o['AffectedRuns'] = $this->AffectedRuns;
        if (isset($this->SlaBreaches)) $o['SlaBreaches'] = $this->SlaBreaches;
        if (isset($this->Throughput)) $o['Throughput'] = JsonConverters::toArray('WorkflowThroughputView', $this->Throughput);
        if (isset($this->ByVertical)) $o['ByVertical'] = JsonConverters::toArray('WorkflowVerticalHealthView', $this->ByVertical);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class EngineHealthRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>