| Requires the role: | superadmin |
| POST | /widget/configurationschema | Create a widget configuration schema | Creates a new schema. SuperAdmin only. Schemas are global and immutable: there is no PUT or DELETE. |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="Returned if there is a validation error or the schema is invalid JSON Schema", StatusCode=400)
// @ApiResponse(Description="Returned if a schema with this Version already exists", StatusCode=409)
// @ApiResponse(Description="Returned if the current user is not a SuperAdmin", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateWidgetConfigurationSchema : Codable
{
/**
* The schema version. Must be unique.
*/
// @ApiMember(Description="The schema version. Must be unique.", IsRequired=true)
public var version:Int
/**
* The JSON Schema document.
*/
// @ApiMember(Description="The JSON Schema document.", IsRequired=true)
public var schema:[String:String] = [:]
required public init(){}
}
public class WidgetConfigurationSchemaResponse : Codable
{
public var id:Int
public var version:Int
public var schema:[String:String] = [:]
public var createdDate:Date
public var responseStatus:ResponseStatus
required public init(){}
}
Swift CreateWidgetConfigurationSchema DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /widget/configurationschema HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Version":0,"Schema":{"String":{}}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Id":0,"Version":0,"Schema":{"String":{}},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}