Add a Device
post
/api/device/Devices
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CustomName: string
Device Custom Name
-
DevicePriorityID: integer
Device Priority ID
-
DeviceSNMPAccessID: integer
SNMP Access Profile ID
-
DeviceStateID: integer
Allowed Values:
[ 0, 1, 2, 3, 101, 102 ]
Device State ID - `0` => New - `1` => Non-discoverable - `2` => Verified (Discovered) - `3` => Discovered (Fully) - `101` => Static (Disabled) - `102` => Virtual (non-device) -
DeviceTypeCategoryID: integer
Device Type Category ID
-
DeviceZoneID: integer
Device Zone ID
-
DNSName: string
Device DNS Name
-
GeoLocation: string
GeoJSON Point of device location (lon, lat)
-
InitialDeviceGroupID: integer
Initial Device Group ID
-
IPv4: string
IP Address (v4)
-
IPv6: string
IP Address (v6) - hex notation
-
MetaData: array
MetaData
MetaData object definitions for device (DeviceMetaTypeID, MetaData)
-
ParentDeviceID: integer
DeviceID of Parent for Virtual Devices
-
ShardID: integer
Shard ID of Device
Nested Schema : MetaData
Type:
array
MetaData object definitions for device (DeviceMetaTypeID, MetaData)
Show Source
Nested Schema : items
Type:
object
Response
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
message: string
Response message in textExample:
Added record
-
success: boolean
Success or failure responseExample:
true
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
List of errors reported. Validation errors will be keyed by record field.
-
message: string
Response message in textExample:
Exception thrown
-
success: boolean
Success or failure responseExample:
false
Nested Schema : errors
Type:
array
List of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object