BokaMera.API.Host

<back to all web services

DeleteWidgetConfigurationSchemaMigration

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
DELETE/widget/configurationschema/{Version}/migrationClear the migration patch for a schema versionSets MigrationFromPreviousVersion back to NULL for the given Version. SuperAdmin only. Idempotent — deleting an already-cleared value is a no-op success.
import 'package:servicestack/servicestack.dart';

class WidgetConfigurationSchemaResponse implements IConvertible
{
    int Id = 0;
    int Version = 0;
    Map<String,dynamic?> Schema = {};
    String? DefaultConfiguration;
    String? MigrationFromPreviousVersion;
    DateTime CreatedDate = DateTime(0);
    ResponseStatus ResponseStatus;

    WidgetConfigurationSchemaResponse({this.Id,this.Version,this.Schema,this.DefaultConfiguration,this.MigrationFromPreviousVersion,this.CreatedDate,this.ResponseStatus});
    WidgetConfigurationSchemaResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Version = json['Version'];
        Schema = JsonConverters.fromJson(json['Schema'],'Map<String,dynamic?>',context!);
        DefaultConfiguration = json['DefaultConfiguration'];
        MigrationFromPreviousVersion = json['MigrationFromPreviousVersion'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Version': Version,
        'Schema': JsonConverters.toJson(Schema,'Map<String,dynamic?>',context!),
        'DefaultConfiguration': DefaultConfiguration,
        'MigrationFromPreviousVersion': MigrationFromPreviousVersion,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "WidgetConfigurationSchemaResponse";
    TypeContext? context = _ctx;
}

// @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 IConvertible
{
    /**
    * The schema version whose migration patch should be cleared.
    */
    // @ApiMember(Description="The schema version whose migration patch should be cleared.", IsRequired=true, ParameterType="path")
    int Version = 0;

    DeleteWidgetConfigurationSchemaMigration({this.Version});
    DeleteWidgetConfigurationSchemaMigration.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Version = json['Version'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Version': Version
    };

    getTypeName() => "DeleteWidgetConfigurationSchemaMigration";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'WidgetConfigurationSchemaResponse': TypeInfo(TypeOf.Class, create:() => WidgetConfigurationSchemaResponse()),
    'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
    'DeleteWidgetConfigurationSchemaMigration': TypeInfo(TypeOf.Class, create:() => DeleteWidgetConfigurationSchemaMigration()),
});

Dart DeleteWidgetConfigurationSchemaMigration DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Version":0,"Schema":{"String":{}},"DefaultConfiguration":"String","MigrationFromPreviousVersion":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}