Create a Device Type
post
/api/device/Types
Creates a new device type.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : schema
Type:
Show Source
object
-
DeviceTypeCategoryID: integer
The device type category ID.Example:
13
-
DeviceTypeName: string
The device type name.Example:
(any Cable/DSL Router?)
-
DeviceTypeVendorID: integer
The device type vendor ID.Example:
79
-
SysObjectID: string
SNMP Object IDExample:
1.3.6.1.4.1.3955.1.1
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
The properties of the new device type.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : deviceTypesRead
Type:
Show Source
object
-
DeviceTypeCategoryID: object
DeviceTypeCategoryID
-
DeviceTypeCategoryName: string
The device type category name.Example:
Appliance
-
DeviceTypeName: string
The device type name.Example:
(any Cable/DSL Router?)
-
DeviceTypeVendorID: object
DeviceTypeVendorID
-
DeviceTypeVendorName: string
The device type vendor name.Example:
LinkSys
-
SysObjectID: string
SNMP Object IDExample:
1.3.6.1.4.1.3955.1.1
-
TypeID: string
Formatted SysObjectID with 'id-' as device type id, for use between UI and APIExample:
id-1.3.6.1.4.1.3955.1.1
Nested Schema : DeviceTypeCategoryID
Type:
Show Source
object
-
id: integer
The device type category ID.Example:
13
-
name: string
The device type category name.Example:
Appliance
Nested Schema : DeviceTypeVendorID
Type:
Show Source
object
-
id: integer
The device type vendor ID.Example:
79
-
name: string
The device type vendor name.Example:
LinkSys
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