| GET,OPTIONS | /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 WorkflowVersionInfo implements JsonSerializable
{
public function __construct(
/** @var int */
public int $VersionNum=0,
/** @var string|null */
public ?string $Status=null,
/** @var string|null */
public ?string $CreatedBy=null,
/** @var DateTime */
public DateTime $CreatedAt=new DateTime(),
/** @var DateTime|null */
public ?DateTime $PublishedAt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['VersionNum'])) $this->VersionNum = $o['VersionNum'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
if (isset($o['PublishedAt'])) $this->PublishedAt = JsonConverters::from('DateTime', $o['PublishedAt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->VersionNum)) $o['VersionNum'] = $this->VersionNum;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
if (isset($this->PublishedAt)) $o['PublishedAt'] = JsonConverters::to('DateTime', $this->PublishedAt);
return empty($o) ? new class(){} : $o;
}
}
class WorkflowView implements JsonSerializable
{
public function __construct(
/** @var int */
public int $WorkflowId=0,
/** @var string|null */
public ?string $SourceKey=null,
/** @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 $Status=null,
/** @var int */
public int $VersionNum=0,
/** @var string|null */
public ?string $Description=null,
/** @var string|null */
public ?string $OwnerRole=null,
/** @var string|null */
public ?string $GraphJson=null,
/** @var int */
public int $Ok30=0,
/** @var int */
public int $Fail30=0,
/** @var int */
public int $Waiting=0,
/** @var string|null */
public ?string $UpdatedBy=null,
/** @var DateTime|null */
public ?DateTime $UpdatedAt=null,
/** @var array<WorkflowVersionInfo>|null */
public ?array $Versions=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['WorkflowId'])) $this->WorkflowId = $o['WorkflowId'];
if (isset($o['SourceKey'])) $this->SourceKey = $o['SourceKey'];
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['Status'])) $this->Status = $o['Status'];
if (isset($o['VersionNum'])) $this->VersionNum = $o['VersionNum'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['OwnerRole'])) $this->OwnerRole = $o['OwnerRole'];
if (isset($o['GraphJson'])) $this->GraphJson = $o['GraphJson'];
if (isset($o['Ok30'])) $this->Ok30 = $o['Ok30'];
if (isset($o['Fail30'])) $this->Fail30 = $o['Fail30'];
if (isset($o['Waiting'])) $this->Waiting = $o['Waiting'];
if (isset($o['UpdatedBy'])) $this->UpdatedBy = $o['UpdatedBy'];
if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
if (isset($o['Versions'])) $this->Versions = JsonConverters::fromArray('WorkflowVersionInfo', $o['Versions']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->WorkflowId)) $o['WorkflowId'] = $this->WorkflowId;
if (isset($this->SourceKey)) $o['SourceKey'] = $this->SourceKey;
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->Status)) $o['Status'] = $this->Status;
if (isset($this->VersionNum)) $o['VersionNum'] = $this->VersionNum;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->OwnerRole)) $o['OwnerRole'] = $this->OwnerRole;
if (isset($this->GraphJson)) $o['GraphJson'] = $this->GraphJson;
if (isset($this->Ok30)) $o['Ok30'] = $this->Ok30;
if (isset($this->Fail30)) $o['Fail30'] = $this->Fail30;
if (isset($this->Waiting)) $o['Waiting'] = $this->Waiting;
if (isset($this->UpdatedBy)) $o['UpdatedBy'] = $this->UpdatedBy;
if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
if (isset($this->Versions)) $o['Versions'] = JsonConverters::toArray('WorkflowVersionInfo', $this->Versions);
return empty($o) ? new class(){} : $o;
}
}
class EngineWorkflowsResponse implements JsonSerializable
{
public function __construct(
/** @var array<WorkflowView>|null */
public ?array $Workflows=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Workflows'])) $this->Workflows = JsonConverters::fromArray('WorkflowView', $o['Workflows']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Workflows)) $o['Workflows'] = JsonConverters::toArray('WorkflowView', $this->Workflows);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class EngineWorkflowsRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
PHP EngineWorkflowsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/engine/workflows HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<EngineWorkflowsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Workflows>
<WorkflowView>
<Description>String</Description>
<Fail30>0</Fail30>
<GraphJson>String</GraphJson>
<Name>String</Name>
<Ok30>0</Ok30>
<OwnerRole>String</OwnerRole>
<Pack>String</Pack>
<SourceKey>String</SourceKey>
<Status>String</Status>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy>String</UpdatedBy>
<VersionNum>0</VersionNum>
<Versions>
<WorkflowVersionInfo>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<PublishedAt>0001-01-01T00:00:00</PublishedAt>
<Status>String</Status>
<VersionNum>0</VersionNum>
</WorkflowVersionInfo>
</Versions>
<Vertical>String</Vertical>
<Waiting>0</Waiting>
<WorkflowId>0</WorkflowId>
</WorkflowView>
</Workflows>
</EngineWorkflowsResponse>