Update Device Shard ID
post
/api/device/DeviceManagement/updateShard
Update the shard ID of devices.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceGroupID: integer
The ID of the device group containing the devices whose shard IDs are to be updated. Either Devices or DeviceGroupID parameter is required.
-
Devices: integer
The comma-separated list of device IDs whose shard IDs are to be updated. Either Devices or DeviceGroupID parameter is required.
-
RecursiveGroup: boolean
Whether the shard IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false.
-
ShardID: integer
The shard ID to update.Example:
1
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
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