Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ShardID":{
            "description":"The shard ID to update.",
            "type":"integer",
            "example":"1"
        },
        "Devices":{
            "description":"The comma-separated list of device IDs whose shard IDs are to be updated. Either Devices or DeviceGroupID parameter is required.",
            "type":"integer"
        },
        "DeviceGroupID":{
            "description":"The ID of the device group containing the devices whose shard IDs are to be updated. Either Devices or DeviceGroupID parameter is required.",
            "type":"integer"
        },
        "RecursiveGroup":{
            "description":"Whether the shard IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (<b>true</b>) or not (<b>false</b>.",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SuccessfulUpdateOperation

Type: object

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top