| Requires the role: | superadmin |
| DELETE | /widget/configurationschema/{Version}/migration | Clear the migration patch for a schema version | Sets MigrationFromPreviousVersion back to NULL for the given Version. SuperAdmin only. Idempotent — deleting an already-cleared value is a no-op success. |
|---|
<?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 WidgetConfigurationSchemaResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var int */
public int $Version=0,
/** @var array<string,Object>|null */
public ?array $Schema=null,
/** @var string|null */
public ?string $DefaultConfiguration=null,
/** @var string|null */
public ?string $MigrationFromPreviousVersion=null,
/** @var DateTime */
public DateTime $CreatedDate=new DateTime(),
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Version'])) $this->Version = $o['Version'];
if (isset($o['Schema'])) $this->Schema = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['Schema']);
if (isset($o['DefaultConfiguration'])) $this->DefaultConfiguration = $o['DefaultConfiguration'];
if (isset($o['MigrationFromPreviousVersion'])) $this->MigrationFromPreviousVersion = $o['MigrationFromPreviousVersion'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Version)) $o['Version'] = $this->Version;
if (isset($this->Schema)) $o['Schema'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->Schema);
if (isset($this->DefaultConfiguration)) $o['DefaultConfiguration'] = $this->DefaultConfiguration;
if (isset($this->MigrationFromPreviousVersion)) $o['MigrationFromPreviousVersion'] = $this->MigrationFromPreviousVersion;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="Returned if Version doesn't exist", StatusCode=404)
// @ApiResponse(Description="Returned if the current user is not a SuperAdmin", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class DeleteWidgetConfigurationSchemaMigration implements JsonSerializable
{
public function __construct(
/** @description The schema version whose migration patch should be cleared. */
// @ApiMember(Description="The schema version whose migration patch should be cleared.", IsRequired=true, ParameterType="path")
/** @var int */
public int $Version=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Version'])) $this->Version = $o['Version'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Version)) $o['Version'] = $this->Version;
return empty($o) ? new class(){} : $o;
}
}
PHP DeleteWidgetConfigurationSchemaMigration 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.
DELETE /widget/configurationschema/{Version}/migration HTTP/1.1
Host: api.bookmore.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WidgetConfigurationSchemaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DefaultConfiguration>String</DefaultConfiguration>
<Id>0</Id>
<MigrationFromPreviousVersion>String</MigrationFromPreviousVersion>
<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>
<Schema xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</Schema>
<Version>0</Version>
</WidgetConfigurationSchemaResponse>