Trendsic Platform Service

<back to all web services

EngineCatalogRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/catalog
<?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 WorkflowCatalogItemView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Desc=null,
        /** @var string|null */
        public ?string $FieldsJson=null
    ) {
    }

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

class WorkflowCatalogGroupView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Vertical=null,
        /** @var string|null */
        public ?string $Color=null,
        /** @var string|null */
        public ?string $Pack=null,
        /** @var array<WorkflowCatalogItemView>|null */
        public ?array $Triggers=null,
        /** @var array<WorkflowCatalogItemView>|null */
        public ?array $Actions=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Vertical'])) $this->Vertical = $o['Vertical'];
        if (isset($o['Color'])) $this->Color = $o['Color'];
        if (isset($o['Pack'])) $this->Pack = $o['Pack'];
        if (isset($o['Triggers'])) $this->Triggers = JsonConverters::fromArray('WorkflowCatalogItemView', $o['Triggers']);
        if (isset($o['Actions'])) $this->Actions = JsonConverters::fromArray('WorkflowCatalogItemView', $o['Actions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Vertical)) $o['Vertical'] = $this->Vertical;
        if (isset($this->Color)) $o['Color'] = $this->Color;
        if (isset($this->Pack)) $o['Pack'] = $this->Pack;
        if (isset($this->Triggers)) $o['Triggers'] = JsonConverters::toArray('WorkflowCatalogItemView', $this->Triggers);
        if (isset($this->Actions)) $o['Actions'] = JsonConverters::toArray('WorkflowCatalogItemView', $this->Actions);
        return empty($o) ? new class(){} : $o;
    }
}

class EngineCatalogResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<WorkflowCatalogGroupView>|null */
        public ?array $Groups=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Groups'])) $this->Groups = JsonConverters::fromArray('WorkflowCatalogGroupView', $o['Groups']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Groups)) $o['Groups'] = JsonConverters::toArray('WorkflowCatalogGroupView', $this->Groups);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

PHP EngineCatalogRequest 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/catalog HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineCatalogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Groups>
    <WorkflowCatalogGroupView>
      <Actions>
        <WorkflowCatalogItemView>
          <Desc>String</Desc>
          <FieldsJson>String</FieldsJson>
          <Name>String</Name>
        </WorkflowCatalogItemView>
      </Actions>
      <Color>String</Color>
      <Pack>String</Pack>
      <Triggers>
        <WorkflowCatalogItemView>
          <Desc>String</Desc>
          <FieldsJson>String</FieldsJson>
          <Name>String</Name>
        </WorkflowCatalogItemView>
      </Triggers>
      <Vertical>String</Vertical>
    </WorkflowCatalogGroupView>
  </Groups>
  <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>
</EngineCatalogResponse>