Trendsic Platform Service

<back to all web services

EngineSandboxRequest

Requires Authentication
The following routes are available for this service:
POST/v1/engine/workflows/{WorkflowId}/test
<?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 WorkflowSandboxStepView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $NodeId=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $Kind=null,
        /** @var string|null */
        public ?string $Outcome=null,
        /** @var string|null */
        public ?string $Detail=null
    ) {
    }

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

class WorkflowSandboxWriteView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $What=null,
        /** @var string|null */
        public ?string $Detail=null
    ) {
    }

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

class EngineSandboxResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Record=null,
        /** @var array<WorkflowSandboxStepView>|null */
        public ?array $Results=null,
        /** @var array<WorkflowSandboxWriteView>|null */
        public ?array $Suppressed=null,
        /** @var array<string>|null */
        public ?array $NotReached=null,
        /** @var array<string>|null */
        public ?array $Unreachable=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class EngineSandboxRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $WorkflowId=0,
        /** @var string|null */
        public ?string $GraphJson=null
    ) {
    }

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

PHP EngineSandboxRequest 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/{WorkflowId}/test HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"WorkflowId":0,"GraphJson":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Record":"String","Results":[{"NodeId":"String","Title":"String","Kind":"String","Outcome":"String","Detail":"String"}],"Suppressed":[{"What":"String","Detail":"String"}],"NotReached":["String"],"Unreachable":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}