Update a Device Zone
put
/api/device/Zones/{id}
Updates the properties of the device zone that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The device zone ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceZoneName(required): string
The new name for the device zone. It must have at least one letter and cannot be entirely numbers.Example:
Default First Zone
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 properties of the updated device zone.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : deviceZonesRead
Type:
Show Source
object
-
DeviceCount: integer
The number of devices.Example:
1
-
DeviceZoneID: integer
The device zone ID.Example:
1
-
DeviceZoneName: string
The device zone name.Example:
Default First Zone
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.