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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @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")
    public static class DeleteWidgetConfigurationSchemaMigration
    {
        /**
        * The schema version whose migration patch should be cleared.
        */
        @ApiMember(Description="The schema version whose migration patch should be cleared.", IsRequired=true, ParameterType="path")
        public Integer Version = null;
        
        public Integer getVersion() { return Version; }
        public DeleteWidgetConfigurationSchemaMigration setVersion(Integer value) { this.Version = value; return this; }
    }

    public static class WidgetConfigurationSchemaResponse
    {
        public Integer Id = null;
        public Integer Version = null;
        public HashMap<String,Object> Schema = new HashMap<String,Object>();
        public String DefaultConfiguration = null;
        public String MigrationFromPreviousVersion = null;
        public Date CreatedDate = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public WidgetConfigurationSchemaResponse setId(Integer value) { this.Id = value; return this; }
        public Integer getVersion() { return Version; }
        public WidgetConfigurationSchemaResponse setVersion(Integer value) { this.Version = value; return this; }
        public HashMap<String,Object> getSchema() { return Schema; }
        public WidgetConfigurationSchemaResponse setSchema(HashMap<String,Object> value) { this.Schema = value; return this; }
        public String getDefaultConfiguration() { return DefaultConfiguration; }
        public WidgetConfigurationSchemaResponse setDefaultConfiguration(String value) { this.DefaultConfiguration = value; return this; }
        public String getMigrationFromPreviousVersion() { return MigrationFromPreviousVersion; }
        public WidgetConfigurationSchemaResponse setMigrationFromPreviousVersion(String value) { this.MigrationFromPreviousVersion = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public WidgetConfigurationSchemaResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public WidgetConfigurationSchemaResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java DeleteWidgetConfigurationSchemaMigration DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}