All Verbs | /RestApi/sitefinity/inlineediting/workflow |
---|
<?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};
enum InlineEditingOperation : string
{
case Publish = 'Publish';
case SaveAsDraft = 'SaveAsDraft';
case Custom = 'Custom';
}
class ItemContextModel implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $ItemId=null,
/** @var string|null */
public ?string $ItemType=null,
/** @var string|null */
public ?string $Provider=null,
/** @var FieldValueModel[]|null */
public ?array $FieldValues=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ItemId'])) $this->ItemId = $o['ItemId'];
if (isset($o['ItemType'])) $this->ItemType = $o['ItemType'];
if (isset($o['Provider'])) $this->Provider = $o['Provider'];
if (isset($o['FieldValues'])) $this->FieldValues = JsonConverters::fromArray('FieldValueModel', $o['FieldValues']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ItemId)) $o['ItemId'] = $this->ItemId;
if (isset($this->ItemType)) $o['ItemType'] = $this->ItemType;
if (isset($this->Provider)) $o['Provider'] = $this->Provider;
if (isset($this->FieldValues)) $o['FieldValues'] = JsonConverters::toArray('FieldValueModel', $this->FieldValues);
return empty($o) ? new class(){} : $o;
}
}
class WorkflowOperationMessage implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PageId=null,
/** @var InlineEditingOperation|null */
public ?InlineEditingOperation $WorkflowOperation=null,
/** @var string|null */
public ?string $CustomWorkflowOperation=null,
/** @var array<ItemContextModel>|null */
public ?array $Items=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PageId'])) $this->PageId = $o['PageId'];
if (isset($o['WorkflowOperation'])) $this->WorkflowOperation = JsonConverters::from('InlineEditingOperation', $o['WorkflowOperation']);
if (isset($o['CustomWorkflowOperation'])) $this->CustomWorkflowOperation = $o['CustomWorkflowOperation'];
if (isset($o['Items'])) $this->Items = JsonConverters::fromArray('ItemContextModel', $o['Items']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PageId)) $o['PageId'] = $this->PageId;
if (isset($this->WorkflowOperation)) $o['WorkflowOperation'] = JsonConverters::to('InlineEditingOperation', $this->WorkflowOperation);
if (isset($this->CustomWorkflowOperation)) $o['CustomWorkflowOperation'] = $this->CustomWorkflowOperation;
if (isset($this->Items)) $o['Items'] = JsonConverters::toArray('ItemContextModel', $this->Items);
return empty($o) ? new class(){} : $o;
}
}
class FieldValueModel implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var Object|null */
public ?Object $Value=null,
/** @var FieldValueModel[]|null */
public ?array $ComplexValue=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Value'])) $this->Value = JsonConverters::from('Object', $o['Value']);
if (isset($o['ComplexValue'])) $this->ComplexValue = JsonConverters::fromArray('FieldValueModel', $o['ComplexValue']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Value)) $o['Value'] = JsonConverters::to('Object', $this->Value);
if (isset($this->ComplexValue)) $o['ComplexValue'] = JsonConverters::toArray('FieldValueModel', $this->ComplexValue);
return empty($o) ? new class(){} : $o;
}
}
PHP WorkflowOperationMessage DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /RestApi/sitefinity/inlineediting/workflow HTTP/1.1
Host: www.asg.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"PageId":"String","WorkflowOperation":"Publish","CustomWorkflowOperation":"String","Items":[{"ItemId":"String","ItemType":"String","Provider":"String","FieldValues":[{"Name":"String","Value":{},"ComplexValue":[{"Name":"String","Value":{},"ComplexValue":[{"Name":"String","Value":{}}]}]}]}]}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length [{"ItemName":"String","ItemType":"String","ItemStatus":{"DisplayStatus":"String","IsAdmin":false,"IsEditable":false,"IsStatusEditable":false,"IsLocked":false,"IsPublished":false,"IsLockedByMe":false,"LockedByUsername":"String","WorkflowStatus":"String"},"ProviderName":"String","DetailsViewUrl":"String"}]