Trendsic Platform Service

<back to all web services

EngineWorkflowCreateRequest

Requires Authentication
The following routes are available for this service:
POST/v1/engine/workflows
<?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 EngineWorkflowMutationResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $WorkflowId=0,
        /** @var int */
        public int $VersionNum=0,
        /** @var bool|null */
        public ?bool $Forked=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var int */
        public int $ChangeRequestId=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class EngineWorkflowCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Vertical=null,
        /** @var string|null */
        public ?string $Pack=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $GraphJson=null,
        /** @var string|null */
        public ?string $SourceKey=null
    ) {
    }

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

PHP EngineWorkflowCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/engine/workflows HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Name":"String","Vertical":"String","Pack":"String","Description":"String","GraphJson":"String","SourceKey":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"WorkflowId":0,"VersionNum":0,"Forked":false,"Status":"String","ChangeRequestId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}