| GET | /widget/configurationschema | List widget configuration schemas | Returns all known configuration schemas, sortable via OrderBy. Schemas are global (not company-scoped); the schema document itself (Schema, DefaultConfiguration) is immutable per Version. The one exception is MigrationFromPreviousVersion, which can be set/replaced via PUT /widget/configurationschema/{Version}/migration. |
|---|
import Foundation
import ServiceStack
public class WidgetConfigurationSchemaQuery : Codable
{
/**
* Filter by version.
*/
// @ApiMember(Description="Filter by version.")
public var version:Int?
/**
* Number of records to skip
*/
// @ApiMember(Description="Number of records to skip")
public var skip:Int?
/**
* Number of records to take
*/
// @ApiMember(Description="Number of records to take")
public var take:Int?
/**
* Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate.
*/
// @ApiMember(Description="Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate.")
public var orderBy:String
required public init(){}
}
public class AccessKeyTypeResponse : Codable
{
public var id:Int
public var keyType:String
public var Description:String
required public init(){}
}
Swift WidgetConfigurationSchemaQuery DTOs
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.
GET /widget/configurationschema HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
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
}
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}