Create a Device Group
post
/api/device/Groups
Creates a new device group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : schema
Type:
Show Source
object
-
DeviceGroupName: string
The device group name.Example:
Root
-
Devices: array
Devices
The list of devices.
-
ParentDeviceGroupID: integer
The device group ID of the parent group.Example:
1
-
Remove: boolean
Whether to remove the device from other device groups (1 for true) or not (0 for false).Example:
0
Nested Schema : items
Type:
Show Source
object
-
DeviceID: integer
Example:
1
-
DeviceName: string
Example:
router.example.com
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 group.
Nested Schema : deviceGroupsReadById
Type:
Show Source
object
-
DeviceGroupID: integer
The device group ID.Example:
2
-
DeviceGroupName: string
The device group display name.Example:
Nodes
-
Devices: array
Devices
The list of devices.
-
ParentDeviceGroupID: integer
The device group ID of the parent group.Example:
1
Nested Schema : items
Type:
Show Source
object
-
DeviceID: integer
Example:
1
-
DeviceName: string
Example:
router.example.com
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