| 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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WidgetConfigurationSchemaResponse:
id: int = 0
version: int = 0
schema: Dict[str, Object] = field(default_factory=dict)
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
response_status: Optional[ResponseStatus] = None
# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateWidgetConfigurationSchema:
# @ApiMember(Description="The schema version. Must be unique.", IsRequired=true)
version: int = 0
"""
The schema version. Must be unique.
"""
# @ApiMember(Description="The JSON Schema document.", IsRequired=true)
schema: Dict[str, Object] = field(default_factory=dict)
"""
The JSON Schema document.
"""
Python 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"}}}