BokaMera.API.Host

<back to all web services

SetWidgetConfigurationSchemaMigration

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
PUT/widget/configurationschema/{Version}/migrationSet or replace the migration patch from the previous schema versionSets MigrationFromPreviousVersion for the given Version. SuperAdmin only. Overwrites any existing value for this Version — unlike the schema document itself, this field is expected to be corrected after authoring, not immutable.
SetWidgetConfigurationSchemaMigration Parameters:
NameParameterData TypeRequiredDescription
VersionpathintYesThe schema version this patch produces.
PatchbodystringYesJSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string.
WidgetConfigurationSchemaResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
VersionformintNo
SchemaformDictionary<string, Object>Yes
DefaultConfigurationformstringNo
MigrationFromPreviousVersionformstringNo
CreatedDateformDateTimeNo
ResponseStatusformResponseStatusYes

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /widget/configurationschema/{Version}/migration HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Version":0,"Patch":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}