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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WidgetConfigurationSchemaResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val Version:Int32 = new Int32() with get,set
        member val Schema:Dictionary<String, Object> = null with get,set
        member val DefaultConfiguration:String = null with get,set
        member val MigrationFromPreviousVersion:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<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")>]
    [<AllowNullLiteral>]
    type DeleteWidgetConfigurationSchemaMigration() = 
        ///<summary>
        ///The schema version whose migration patch should be cleared.
        ///</summary>
        [<ApiMember(Description="The schema version whose migration patch should be cleared.", IsRequired=true, ParameterType="path")>]
        member val Version:Int32 = new Int32() with get,set

F# 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
		}
	}
}