| 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. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | query | int? | No | Filter by version. |
| Skip | query | int? | No | Number of records to skip |
| Take | query | int? | No | Number of records to take |
| OrderBy | query | string | Yes | Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<AccessKeyTypeResponse> | Yes | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| KeyType | form | string | Yes | |
| Description | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}