| Requires the role: | superadmin |
| PUT | /widget/configurationschema/{Version}/migration | Set or replace the migration patch from the previous schema version | Sets 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. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | path | int | Yes | The schema version this patch produces. |
| Patch | body | string | Yes | JSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Version | form | int | No | |
| Schema | form | Dictionary<string, Object> | Yes | |
| DefaultConfiguration | form | string | No | |
| MigrationFromPreviousVersion | form | string | No | |
| CreatedDate | form | DateTime | No | |
| ResponseStatus | form | ResponseStatus | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
Version: 0,
Patch: String
}
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
}
}
}