Get Blackout Window

Get All Blackout Windows

Query Parameters

• showOnlyCommcellLevel boolean

  Shows blackout window at commcell level if set to true.

• companyId integer

  Shows blackout windows associated with the company whose id has been provided.

• serverGroupId string

  Shows blackout windows associated with the server group whose id has been provided.

• commcellId string

  Shows blackout windows associated with the commcell whose id has been provided.

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• blackoutWindows object[]

  Returns a summary of all blackout windows

  id int32

  blackout window Id

  name string

  blackout window name

  company object

  id int32

  name string

  allDays object[]

  Days of the week along with the time on which the black out window will be in effect.

  days string[]

  Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

  Days of the week when the blackout window will be in effect.

  time object

  start int64

  the blackout window comes into effect at this point.

  end int64

  the blackout window is no longer in effect from this point on.

  betweenDates object

  start int64

  the blackout window comes into effect at this point.

  end int64

  the blackout window is no longer in effect from this point on.

{
  "blackoutWindows": [
    {
      "id": 0,
      "name": "string",
      "company": {
        "id": 0,
        "name": "string"
      },
      "allDays": [
        {
          "days": [
            "SUNDAY"
          ],
          "time": {
            "start": 0,
            "end": 0
          }
        }
      ],
      "betweenDates": {
        "start": 0,
        "end": 0
      }
    }
  ]
}

Requested Details not found

GET /v5/blackoutwindow    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

showOnlyCommcellLevel — query

---truefalse

companyId — query

serverGroupId — query

commcellId — query

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V5/BlackoutWindow' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'