Jump to

• Request
• Response

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 ids

  Example:

  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 ASC

  Example:

  id:ASC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

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.

{
    "x-em-sdk-level":"emSDK",
    "description":"Collection of blackout reasons.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of items in this page.",
            "example":"1"
        },
        "total":{
            "type":"integer",
            "description":"Total number of items in this request. This has to be explicitly included in the request."
        },
        "items":{
            "type":"array",
            "description":"blackout reasons",
            "items":{
                "$ref":"#/components/schemas/BlackoutReasonSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "required":[
                "self"
            ],
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackoutReasons?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the next page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackoutReasons?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : items

Type: array

blackout reasons

Show Source

• Array of: object BlackoutReasonSummary
  A single blackout reason.

{
    "type":"array",
    "description":"blackout reasons",
    "items":{
        "$ref":"#/components/schemas/BlackoutReasonSummary"
    }
}

Nested Schema : links

Type: object

Result set navigation links.

Show Source

• next: next
• previous: previous
• self(required): self

{
    "type":"object",
    "description":"Result set navigation links.",
    "required":[
        "self"
    ],
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackoutReasons?page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the next page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackoutReasons?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : BlackoutReasonSummary

Type: object

A single blackout reason.

Match All

Show Source

• object allOf BlackoutReason
  A single blackout reason.

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BlackoutReason"
        }
    ]
}

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.

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "properties":{
        "reasonDisplayName":{
            "type":"string",
            "description":"Localized predefined reason or the user defined reason as provided by the user."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonId"
        },
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

Match All

Show Source

• object ReasonId
  Reason id of a blackout.
• object Reason
  Reason of a blackout.

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "properties":{
        "reasonDisplayName":{
            "type":"string",
            "description":"Localized predefined reason or the user defined reason as provided by the user."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonId"
        },
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

Nested Schema : ReasonId

Type: object

Reason id of a blackout.

Show Source

• id: string
  Reason id of a blackout.

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason id of a blackout.",
    "properties":{
        "id":{
            "type":"string",
            "description":"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.

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason of a blackout.",
    "properties":{
        "reason":{
            "type":"string",
            "description":"Predefined reason in English or a user defined reason."
        }
    }
}

Nested Schema : next

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Link to the next page in the result set.
• Example: { "href":"/em/api/blackoutReasons?page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the next page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackoutReasons?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Link to the previous page in the result set.
• Example: { "href":"/em/api/blackoutReasons?page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the previous page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackoutReasons?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Link to the current page in the result set.
• Example: { "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the current page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackoutReasons?page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top