REST API for Unified Assurance Core

Update Device Zone ID

post

/api/device/DeviceManagement/updateZone

Updates the zone ID of devices.
The minimum required properties in the request body are:

DeviceZoneID
DeviceGroupID (include either this or Devices)
Devices (include either this or DeviceGroupID)

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

DeviceGroupID: integer

The ID of the device group containing the devices whose zone IDs are to be updated. Either Devices or DeviceGroupID parameter is required.
Devices: integer

The comma-separated list of device IDs whose zone IDs are to be updated. Either Devices or DeviceGroupID parameter is required.
DeviceZoneID: integer

The device zone ID to update.

Example: 1
RecursiveGroup: boolean

Whether the zone IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).

{
    "type":"object",
    "properties":{
        "DeviceZoneID":{
            "description":"The device zone ID to update.",
            "type":"integer",
            "example":"1",
            "required":true
        },
        "Devices":{
            "description":"The comma-separated list of device IDs whose zone 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 zone IDs are to be updated. Either Devices or DeviceGroupID parameter is required.",
            "type":"integer"
        },
        "RecursiveGroup":{
            "description":"Whether the zone 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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root 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

{
    "description":"The response body for a successful update operation.",
    "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

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":{
                "description":"An error.",
                "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

An error.

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

Nested Schema : items

Type: object

An error.