Create a Device Type Category
post
/api/device/Categories
Creates a new device type category.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- DeviceTypeCategoryName
- ImageName
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceTypeCategoryName: string
The device type category 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:Appliance
-
ImageName: string
The image name.Example:
fugue/drive-network.png
-
Source: string
The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.Example:
Image
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
The properties of the new device type category.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : deviceCategoriesRead
Type:
Show Source
object
-
DeviceTypeCategoryID: integer
The device type category IDs specified for individual CRUD operations.Example:
13
-
DeviceTypeCategoryName: string
The device type category name.Example:
Appliance
-
ImageName: string
The name of the icon, Font Awesome icon, or path to the icon.Example:
fugue/drive-network.png
-
Source: string
The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.Example:
Image
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.