Create an Application Configuration Type
post
/api/broker/ApplicationConfigTypes
Creates a new application configuration type.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- BrokerApplicationConfigName
- RenderTypeID
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BrokerApplicationConfigName: string
The application configuration name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.Example:LogLevel
-
RenderTypeID: integer
The render type ID.Example:
12
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
object
The response body for a successful add operation.
Show Source
-
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 : brokerApplicationConfigTypesRead
Type:
Show Source
object
-
BrokerApplicationConfigName: string
The application configuration name.Example:
LogLevel
-
BrokerApplicationConfigTypeID: integer
The application configuration type ID.Example:
1
-
DisplayName: string
The display name.Example:
DisplayNameExample
-
icon: string
The icon representing the configuration state.Example:
icon.png
-
RenderType: string
The render type.Example:
exampleType
-
RenderTypeID: integer
The render type ID.Example:
12
-
RenderTypeName: string
The render type name.Example:
exampleName
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.