Jump to

• Request
• Response

Create a Device Maintenance Window

post

/api/device/Windows

Creates a new device maintenance window.
The minimum required properties in the request body are:

• WindowName
• StartTime
• StopTime
• Devices

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/deviceWindows"
        }
    ],
    "required":[
        "WindowName",
        "StartTime",
        "StopTime",
        "Devices"
    ]
}

Nested Schema : schema

Type: object

Show Source

• 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: Maintenance window 2
• WindowName: string
  The device maintenance window name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: device-nav

{
    "type":"object",
    "properties":{
        "WindowName":{
            "description":"The device maintenance window name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"device-nav"
        },
        "StartTime":{
            "description":"The maintenance window start time in epoch time.",
            "type":"string",
            "example":1691364600
        },
        "StopTime":{
            "description":"The maintenance window stop time in epoch time.",
            "type":"string",
            "example":1691969400
        },
        "Devices":{
            "$ref":"#/components/schemas/deviceWindowsRead/properties/Devices"
        },
        "WindowDescr":{
            "$ref":"#/components/schemas/deviceWindowsRead/properties/WindowDescr"
        }
    }
}

Nested Schema : Devices

Type: array

The array of maintenance window devices.

Show Source

• Array of: object items

{
    "description":"The array of maintenance window devices.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DeviceID":{
                "description":"The device ID.",
                "type":"integer"
            },
            "DeviceName":{
                "description":"The device name.",
                "type":"string"
            },
            "DeviceZoneID":{
                "description":"The device zone ID.",
                "type":"integer"
            }
        }
    },
    "example":[
        {
            "DeviceID":"2",
            "DeviceName":"router1.example",
            "DeviceZoneID":"1"
        },
        {
            "DeviceID":"4",
            "DeviceName":"router2.example",
            "DeviceZoneID":"1"
        }
    ]
}

Example:

[
    {
        "DeviceID":"2",
        "DeviceName":"router1.example",
        "DeviceZoneID":"1"
    },
    {
        "DeviceID":"4",
        "DeviceName":"router2.example",
        "DeviceZoneID":"1"
    }
]

Nested Schema : items

Type: object

Show Source

• DeviceID: integer
  The device ID.
• DeviceName: string
  The device name.
• DeviceZoneID: integer
  The device zone ID.

{
    "type":"object",
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer"
        },
        "DeviceName":{
            "description":"The device name.",
            "type":"string"
        },
        "DeviceZoneID":{
            "description":"The device zone ID.",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new device maintenance window.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceWindowsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new device maintenance window.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device maintenance window.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceWindowsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new device maintenance window.

Show Source

• Array of: object deviceWindowsRead

{
    "description":"The properties of the new device maintenance window.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceWindowsRead"
    }
}

Nested Schema : deviceWindowsRead

Type: object

Show Source

• 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: Maintenance window 2
• WindowID: integer
  The device maintenance window ID.

  Example: 2
• WindowName: string
  The device maintenance window name.

  Example: device-nav

{
    "type":"object",
    "properties":{
        "WindowID":{
            "description":"The device maintenance window ID.",
            "type":"integer",
            "example":"2"
        },
        "WindowName":{
            "description":"The device maintenance window name.",
            "type":"string",
            "example":"device-nav"
        },
        "WindowDescr":{
            "description":"The device maintenance window description.",
            "type":"string",
            "example":"Maintenance window 2"
        },
        "StartTime":{
            "description":"The maintenance window start time in YYYY-MM-DD HH:MM:SS format, converted from epoch time.",
            "type":"string",
            "example":"2023-08-07 05:00:00"
        },
        "StopTime":{
            "description":"The maintenance window stop time in YYYY-MM-DD HH:MM:SS format, converted from epoch time.",
            "type":"string",
            "example":"2023-08-14 05:00:00"
        },
        "DeviceCount":{
            "description":"The number of devices with the assigned <b>WindowID</b>.",
            "type":"integer",
            "example":"2"
        },
        "Devices":{
            "description":"The array of maintenance window devices.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DeviceID":{
                        "description":"The device ID.",
                        "type":"integer"
                    },
                    "DeviceName":{
                        "description":"The device name.",
                        "type":"string"
                    },
                    "DeviceZoneID":{
                        "description":"The device zone ID.",
                        "type":"integer"
                    }
                }
            },
            "example":[
                {
                    "DeviceID":"2",
                    "DeviceName":"router1.example",
                    "DeviceZoneID":"1"
                },
                {
                    "DeviceID":"4",
                    "DeviceName":"router2.example",
                    "DeviceZoneID":"1"
                }
            ]
        }
    }
}

Nested Schema : Devices

Type: array

The array of maintenance window devices.

Show Source

• Array of: object items

{
    "description":"The array of maintenance window devices.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DeviceID":{
                "description":"The device ID.",
                "type":"integer"
            },
            "DeviceName":{
                "description":"The device name.",
                "type":"string"
            },
            "DeviceZoneID":{
                "description":"The device zone ID.",
                "type":"integer"
            }
        }
    },
    "example":[
        {
            "DeviceID":"2",
            "DeviceName":"router1.example",
            "DeviceZoneID":"1"
        },
        {
            "DeviceID":"4",
            "DeviceName":"router2.example",
            "DeviceZoneID":"1"
        }
    ]
}

Example:

[
    {
        "DeviceID":"2",
        "DeviceName":"router1.example",
        "DeviceZoneID":"1"
    },
    {
        "DeviceID":"4",
        "DeviceName":"router2.example",
        "DeviceZoneID":"1"
    }
]

Nested Schema : items

Type: object

Show Source

• DeviceID: integer
  The device ID.
• DeviceName: string
  The device name.
• DeviceZoneID: integer
  The device zone ID.

{
    "type":"object",
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer"
        },
        "DeviceName":{
            "description":"The device name.",
            "type":"string"
        },
        "DeviceZoneID":{
            "description":"The device zone ID.",
            "type":"integer"
        }
    }
}

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":{
                "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.

Back to Top