Create a Device Maintenance Window
post
/api/device/Windows
Creates a new device maintenance window.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : schema
Type:
Show Source
object
-
Devices: array
Devices
The array of maintenance window devices.
-
StartTime: string
The maintenance window start time in epoch time.Example:
1691364600
-
StopTime: string
The maintenance window stop time in epoch time.Example:
1691969400
-
WindowDescr: string
The device maintenance window description.Example:
-
WindowName: string
The device maintenance window name.Example:
device-nav
Nested Schema : Devices
Type:
array
The array of maintenance window devices.
Show Source
Example:
[
{
"DeviceID":"2",
"DeviceName":"router1.example",
"DeviceZoneID":"1"
},
{
"DeviceID":"4",
"DeviceName":"router2.exapmle",
"DeviceZoneID":"1"
}
]
Nested Schema : items
Type:
Show Source
object
-
DeviceID: integer
The device ID.
-
DeviceName: string
The device name.
-
DeviceZoneID: integer
Device zone ID
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added 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 new device maintenance window.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : deviceWindowsRead
Type:
Show Source
object
-
DeviceCount: integer
The number of devices with the assigned WindowID.Example:
2
-
Devices: array
Devices
The array of maintenance window devices.
-
StartTime: string
The maintenance window start time in YYYY-MM-DD HH:MM:SS format, converted from epoch time.Example:
2023-08-07 05:00:00
-
StopTime: string
The maintenance window stop time in YYYY-MM-DD HH:MM:SS format, converted from epoch time.Example:
2023-08-14 05:00:00
-
WindowDescr: string
The device maintenance window description.Example:
-
WindowID: integer
The device maintenance window ID.Example:
2
-
WindowName: string
The device maintenance window name.Example:
device-nav
Nested Schema : Devices
Type:
array
The array of maintenance window devices.
Show Source
Example:
[
{
"DeviceID":"2",
"DeviceName":"router1.example",
"DeviceZoneID":"1"
},
{
"DeviceID":"4",
"DeviceName":"router2.exapmle",
"DeviceZoneID":"1"
}
]
Nested Schema : items
Type:
Show Source
object
-
DeviceID: integer
The device ID.
-
DeviceName: string
The device name.
-
DeviceZoneID: integer
Device zone ID
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