Trendsic Platform Service

<back to all web services

EngineTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/templates
<?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 WorkflowTemplateView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $TemplateKey=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Pack=null,
        /** @var array<string>|null */
        public ?array $Verticals=null,
        /** @var string|null */
        public ?string $RefSourceKey=null,
        /** @var string|null */
        public ?string $GraphJson=null,
        /** @var int */
        public int $StepCount=0,
        /** @var int */
        public int $Installs=0,
        /** @var string|null */
        public ?string $Description=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TemplateKey'])) $this->TemplateKey = $o['TemplateKey'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Pack'])) $this->Pack = $o['Pack'];
        if (isset($o['Verticals'])) $this->Verticals = JsonConverters::fromArray('string', $o['Verticals']);
        if (isset($o['RefSourceKey'])) $this->RefSourceKey = $o['RefSourceKey'];
        if (isset($o['GraphJson'])) $this->GraphJson = $o['GraphJson'];
        if (isset($o['StepCount'])) $this->StepCount = $o['StepCount'];
        if (isset($o['Installs'])) $this->Installs = $o['Installs'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TemplateKey)) $o['TemplateKey'] = $this->TemplateKey;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Pack)) $o['Pack'] = $this->Pack;
        if (isset($this->Verticals)) $o['Verticals'] = JsonConverters::toArray('string', $this->Verticals);
        if (isset($this->RefSourceKey)) $o['RefSourceKey'] = $this->RefSourceKey;
        if (isset($this->GraphJson)) $o['GraphJson'] = $this->GraphJson;
        if (isset($this->StepCount)) $o['StepCount'] = $this->StepCount;
        if (isset($this->Installs)) $o['Installs'] = $this->Installs;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

PHP EngineTemplatesRequest 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/templates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"Templates":[{"TemplateKey":"String","Name":"String","Pack":"String","Verticals":["String"],"RefSourceKey":"String","GraphJson":"String","StepCount":0,"Installs":0,"Description":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}