| POST | /v1/messaging/workflows/{WorkflowId}/replace | ||
|---|---|---|---|
| POST | /v1/messaging/workflows/{WorkflowId}/keep |
<?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 CompileResult implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $RuleKey=null,
/** @var string */
public string $BranchId='',
/** @var string|null */
public ?string $LineId=null,
/** @var string|null */
public ?string $StepId=null,
/** @var int|null */
public ?int $WorkflowId=null,
/** @var int|null */
public ?int $VersionNum=null,
/** @var string|null */
public ?string $Action=null,
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Note=null,
/** @var bool|null */
public ?bool $Customized=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RuleKey'])) $this->RuleKey = $o['RuleKey'];
if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
if (isset($o['LineId'])) $this->LineId = $o['LineId'];
if (isset($o['StepId'])) $this->StepId = $o['StepId'];
if (isset($o['WorkflowId'])) $this->WorkflowId = $o['WorkflowId'];
if (isset($o['VersionNum'])) $this->VersionNum = $o['VersionNum'];
if (isset($o['Action'])) $this->Action = $o['Action'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Note'])) $this->Note = $o['Note'];
if (isset($o['Customized'])) $this->Customized = $o['Customized'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RuleKey)) $o['RuleKey'] = $this->RuleKey;
if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
if (isset($this->LineId)) $o['LineId'] = $this->LineId;
if (isset($this->StepId)) $o['StepId'] = $this->StepId;
if (isset($this->WorkflowId)) $o['WorkflowId'] = $this->WorkflowId;
if (isset($this->VersionNum)) $o['VersionNum'] = $this->VersionNum;
if (isset($this->Action)) $o['Action'] = $this->Action;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Note)) $o['Note'] = $this->Note;
if (isset($this->Customized)) $o['Customized'] = $this->Customized;
return empty($o) ? new class(){} : $o;
}
}
class MessagingCompileResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<CompileResult>|null */
public ?array $Results=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('CompileResult', $o['Results']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('CompileResult', $this->Results);
return empty($o) ? new class(){} : $o;
}
}
class MessagingWorkflowActionRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $WorkflowId=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['WorkflowId'])) $this->WorkflowId = $o['WorkflowId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->WorkflowId)) $o['WorkflowId'] = $this->WorkflowId;
return empty($o) ? new class(){} : $o;
}
}
PHP MessagingWorkflowActionRequest 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.
POST /v1/messaging/workflows/{WorkflowId}/replace HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<MessagingWorkflowActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<WorkflowId>0</WorkflowId>
</MessagingWorkflowActionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<MessagingCompileResponse 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>
<Results>
<QueueMessagingService.CompileResult>
<Action>String</Action>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<Customized>false</Customized>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<Name>String</Name>
<Note>String</Note>
<RuleKey>String</RuleKey>
<StepId>String</StepId>
<VersionNum>0</VersionNum>
<WorkflowId>0</WorkflowId>
</QueueMessagingService.CompileResult>
</Results>
</MessagingCompileResponse>