List Blackout reasons
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/reasons
This API returns a list of known predefined and user defined blackout reasons. For the predefined blackout reasons there is also a localized display name. For user defined reasons the display name is the same as the reason.
Request
Query Parameters
-
id: integer
filters on specified idsExample:
23
-
limit: integer(int32)
Minimum Value:
1
Maximum Value:2000
To limit the number of rows returned. If the result set is greater, follow the previous and next links in the results.Example:20
-
page: string
System generated page token used in the self, next and previous links.
-
sort: string
The sort field and direction. Allowed sort fields are reason and id. Allowed directions are DESC and ASCExample:
id:ASC
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : BlackoutReasonCollection
Type:
object
Collection of blackout reasons.
Show Source
-
count(required): integer
Number of items in this page.Example:
1
-
items(required): array
items
blackout reasons
-
links(required): object
links
Result set navigation links.
-
total: integer
Total number of items in this request. This has to be explicitly included in the request.
Nested Schema : items
Type:
array
blackout reasons
Show Source
-
Array of:
object BlackoutReasonSummary
A single blackout reason.
Nested Schema : BlackoutReasonSummary
Type:
object
A single blackout reason.
Match All
A single blackout reason.
Show Source
-
object
allOf
BlackoutReason
A single blackout reason.
Nested Schema : BlackoutReason
Type:
object
A single blackout reason.
Show Source
-
reasonDisplayName: string
Localized predefined reason or the user defined reason as provided by the user.
Match All
A single blackout reason.
A single blackout reason.
Show Source
Nested Schema : ReasonId
Type:
object
Reason id of a blackout.
Show Source
-
id: string
Reason id of a blackout.
Nested Schema : Reason
Type:
object
Reason of a blackout.
Show Source
-
reason: string
Predefined reason in English or a user defined reason.
401 Response
Client is not authenticated.
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
500 Response
Internal error serving the request.
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
503 Response
Indicates that a required service is not available.
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported