Create a Preference
post
/api/AAA/Preferences
Creates a new preference.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
PackageName: string
The package name.Example:
event
-
PreferenceDescription: string
The preference description.Example:
Default event list display (default "Default")
-
PreferenceName: string
The preference name.Example:
DefaultDisplayID
-
RenderTypeID: integer
The render type ID.Example:
20004
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : AAAPreferenceRead
Type:
Show Source
object
-
PackageName: string
The package name.Example:
event
-
PreferenceDescription: string
The preference description.Example:
Default event list display (default "Default")
-
PreferenceID: integer
The preference ID.Example:
3
-
PreferenceName: string
The preference name.Example:
DefaultDisplayID
-
RenderType: string
The render type.Example:
{ "id":"1", "name":"String" }
-
RenderTypeID: integer
The render type ID.Example:
20004
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object