Move or Copy Devices to a Different Group
put
/api/device/Groups/updateDevices
Moves or copies devices to a different group. To move, specify a source group in SourceDeviceGroupID. To copy, do not specify a source group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Devices: array
Devices
The list of devices.
-
id(required): integer
The destination device group ID.
-
SourceDeviceGroupID: integer
The source device group ID. To move devices, specify an ID. To copy devices, do not use this parameter.
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
Root Schema : schema
Match All
Show Source
-
object
SuccessfulUpdateOperation
The response body for a successful update operation.
-
object
type
Nested Schema : SuccessfulUpdateOperation
Type:
object
The response body for a successful update operation.
Show Source
-
message: string
The response message.Example:
Updated 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 destination device group with the moved or copied devices.
Nested Schema : data
Type:
array
The destination device group with the moved or copied devices.
Show Source
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.