Get the blackout with the given id

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/{blackoutId}

This API returns the blackout with the given id.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful Response
Body ()
Root Schema : Blackout
Type: object
This is a blackout description.
Show Source
Match All
This is a blackout description.
Show Source
Nested Schema : excludeTargets
Type: array
List of indirect blackout members which should be excluded from blackout.
Show Source
Nested Schema : excludeTypes
Type: array
List of indirect blackout member type names which should be excluded from blackout.
Show Source
Nested Schema : Schedule
Type: object
This represents a schedule object to schedule blackouts.
Show Source
  • Repeat
    Describes repetition of a blackout.
  • Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).
    Example: 2023-08-24T14:54-02:00
Match One Schema
Show Source
  • TimeToEnd
    An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).
  • Duration
    A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.
Nested Schema : TargetIdentifier
Type: object
Identifies a target either by name and typeName or by id.
Show Source
Nested Schema : Repeat
Type: object
Describes repetition of a blackout.
Show Source
  • End time of the repetition with timezone. Timestamps are with minute accuracy.
    Example: 2023-08-24T14:54-02:00
Match One Schema
Show Source
Nested Schema : TimeToEnd
Type: object
An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).
Show Source
Nested Schema : Duration
Type: object
A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.
Show Source
Nested Schema : DaysOfYear
Type: object
List of days of year.
Show Source
Nested Schema : DaysOfMonth
Type: object
List of days of month in range 1-31 or -1 for last day of the month.
Show Source
Nested Schema : DaysOfWeek
Type: object
List of days of week.
Show Source
Nested Schema : EveryNWeeks
Type: object
Repeat every n weeks.
Show Source
Nested Schema : EveryNDays
Type: object
Repeat every n days.
Show Source
Nested Schema : EveryNHours
Type: object
Repeat every n hours.
Show Source
Nested Schema : EveryNMinutes
Type: object
Repeat every n minutes, minimal value is 2.
Show Source
Nested Schema : daysOfYear
Type: array
List of days of the year.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : daysOfMonth
Type: array
List of days of the month (1 based).
Show Source
Example:
[
    "1",
    "15"
]
Nested Schema : daysOfWeek
Type: array
List of days of week (localized short names).
Show Source
Example:
[
    "MO",
    "TH"
]
Examples

400 Response

Error while processing the request. See the response message for the reason.
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

401 Response

Client is not authenticated.
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

404 Response

Resource not found or not authorized
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

500 Response

Internal error serving the request.
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

503 Response

Indicates that a required service is not available.
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source
Back to Top