REST API for Oracle Enterprise Manager

List blackouts

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts

This API returns a list of blackouts based on supplied criteria.

Request

Query Parameters

include: string
Used to include extra information in the result. Right now the only value allowed is "total" which will computes total number of blackouts matching the criteria.
Example:
```
total
```
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
```
name: array[string]

name of the blackout
nameMatches: array[string]

Name pattern of the blackout
owner: array[string]

Owner of the blackout
page: string

System generated page token used in the self, next and previous links.
reason: array[string]

Reason for the blackout
sort: string
The sort field and direction. Allowed sort fields are "name", "status", "id", "timeToStart" and "timeToEnd". Allowed directions are ASC and DESC. Default is "name:ASC".
Example:
```
status:ASC,name:DESC
```
status: array[string]

Status of the blackout (SCHEDULED, START_PROCESSING, START_PARTIAL, START_FAILED, STARTED, STOP_PENDING, STOP_FAILED, STOP_PARTIAL, EDIT_FAILED, EDIT_PARTIAL, EDIT_PENDING, STOPPED, ENDED, END_PARTIAL)
targetId: string
Used to only list blackouts which have the target of the given id as direct blackout member.
Example:
```
ADLKFIDYFSDHFISDOFSDF
```
timeToEndAfter: string
Start of time period for when blackouts are scheduled to end. Timestamps are with minute accuracy and can provide timezone.
Example:
```
2021-03-01T21:23+01:00
```
timeToEndBefore: string
End of time period for when blackouts are scheduled to end. Timestamps are with minute accuracy and can provide timezone.
Example:
```
2021-03-01T21:23+01:00
```
timeToStartAfter: string
Start of time period for when blackouts are scheduled to start. Timestamps are with minute accuracy and can provide timezone.
Example:
```
2021-03-01T21:23+01:00
```
timeToStartBefore: string
End of time period for when blackouts are scheduled to start. Timestamps are with minute accuracy and can provide timezone.
Example:
```
2021-03-01T21:23+01:00
```
type: array[string]

Type of the blackout, valid values are PATCHING, NOTIFICATION or NOTIFICATION_MAINTENANCE

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : BlackoutCollection

Type: object

This is the representation of a list of blackout summaries.

Show Source

count(required): integer

Number of blackouts in this page

Example: 1
items(required): array items

Blackout summaries
links(required): object links

Result set navigation links.
total: integer

Total number of blackouts in this request. This has to be explicitly included in the request.

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of a list of blackout summaries.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of blackouts in this page",
            "example":"1"
        },
        "total":{
            "type":"integer",
            "description":"Total number of blackouts in this request. This has to be explicitly included in the request."
        },
        "items":{
            "type":"array",
            "description":"Blackout summaries",
            "items":{
                "$ref":"#/components/schemas/BlackoutSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts?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/blackouts?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Blackout summaries

Show Source

Array of: object BlackoutSummary

This is the representation of the Blackout summary.

{
    "type":"array",
    "description":"Blackout summaries",
    "items":{
        "$ref":"#/components/schemas/BlackoutSummary"
    }
}

Nested Schema : links

Type: object

Result set navigation links.

Show Source

next: next
previous: previous
self: self

{
    "type":"object",
    "description":"Result set navigation links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts?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/blackouts?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : BlackoutSummary

Type: object

This is the representation of the Blackout summary.

Show Source

id(required): string

Blackout ID

Example: D91786E288D35455C3ADA1B329B49BB5
links(required): object links

Target related links.
name(required): string

Blackout Name

Example: my_blackout
owner(required): string

Owner of the blackout.

Example: scott
reason: string

blackout reason

Example: Network Outage
status(required): string

Allowed Values: [ "SCHEDULED", "START_PROCESSING", "START_PARTIAL", "START_FAILED", "STARTED", "STOP_PENDING", "STOP_FAILED", "STOP_PARTIAL", "EDIT_FAILED", "EDIT_PARTIAL", "EDIT_PENDING", "STOPPED", "ENDED", "END_PARTIAL" ]

Blackout status.
statusDisplayName: string

Status display name in the cient locale.
type(required): string

Default Value: PATCHING

Allowed Values: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]

Type of the blackout.
typeDisplayName: string

Blackout type display name in the client locale

Example: Benachrichtigungsblackout

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of the Blackout summary.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "links",
        "owner"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Blackout type display name in the client locale",
            "example":"Benachrichtigungsblackout"
        },
        "reason":{
            "type":"string",
            "description":"blackout reason",
            "example":"Network Outage"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Status display name in the cient locale."
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout.",
            "example":"scott"
        },
        "links":{
            "type":"object",
            "description":"Target related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Match All

This is the representation of the Blackout summary.

Show Source

object Schedule

This represents a schedule object to schedule blackouts.

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of the Blackout summary.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "links",
        "owner"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Blackout type display name in the client locale",
            "example":"Benachrichtigungsblackout"
        },
        "reason":{
            "type":"string",
            "description":"blackout reason",
            "example":"Network Outage"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Status display name in the cient locale."
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout.",
            "example":"scott"
        },
        "links":{
            "type":"object",
            "description":"Target related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Nested Schema : links

Type: object

Target related links.

Show Source

self: self
targets: targets

{
    "type":"object",
    "description":"Target related links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                    }
                }
            ]
        },
        "targets":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the targets under blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                    }
                }
            ]
        }
    }
}

Nested Schema : Schedule

Type: object

This represents a schedule object to schedule blackouts.

Show Source

repeat: object Repeat

Describes repetition of a blackout.
timeToStart: string

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

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"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"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Match One Schema

Show Source

object 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).
object Duration

A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"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"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Nested Schema : self

Match All

Link to the blackout.

Show Source

object Link

A link referencing a REST API.
Link to the blackout.
Example: { "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
            }
        }
    ]
}

Nested Schema : targets

Match All

Link to the targets under blackout.

Show Source

object Link

A link referencing a REST API.
Link to the targets under blackout.
Example: { "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the targets under blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
            }
        }
    ]
}

Nested Schema : Link

Type: object

A link referencing a REST API.

Show Source

href: string

Link URL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

Nested Schema : Repeat

Type: object

Describes repetition of a blackout.

Show Source

timeToEndRepeat: string

End time of the repetition with timezone. Timestamps are with minute accuracy.

Example: 2023-08-24T14:54-02:00

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Match One Schema

Show Source

object DaysOfYear

List of days of year.
object DaysOfMonth

List of days of month in range 1-31 or -1 for last day of the month.
object DaysOfWeek

List of days of week.
object EveryNWeeks

Repeat every n weeks.
object EveryNDays

Repeat every n days.
object EveryNHours

Repeat every n hours.
object EveryNMinutes

Repeat every n minutes, minimal value is 2.

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

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

timeToEnd(required): string

An end time

Example: 2023-08-23T14:54+01:00

{
    "type":"object",
    "required":[
        "timeToEnd"
    ],
    "description":"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).",
    "properties":{
        "timeToEnd":{
            "type":"string",
            "description":"An end time",
            "example":"2023-08-23T14:54+01:00"
        }
    }
}

Nested Schema : Duration

Type: object

A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

Show Source

durationHours: integer

Duration of the blackout in hours.

Example: 2
durationMinutes: integer

Duration of the blackout in minutes.

Example: 25

{
    "type":"object",
    "description":"A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.",
    "properties":{
        "durationMinutes":{
            "type":"integer",
            "description":"Duration of the blackout in minutes.",
            "example":"25"
        },
        "durationHours":{
            "type":"integer",
            "description":"Duration of the blackout in hours.",
            "example":"2"
        }
    }
}

Nested Schema : DaysOfYear

Type: object

List of days of year.

Show Source

daysOfYear: array daysOfYear

List of days of the year.

{
    "type":"object",
    "description":"List of days of year.",
    "properties":{
        "daysOfYear":{
            "type":"array",
            "description":"List of days of the year.",
            "items":{
                "type":"object",
                "properties":{
                    "month":{
                        "type":"integer",
                        "description":"Month in range of 1-12."
                    },
                    "day":{
                        "type":"integer",
                        "description":"Day in range 1-31 or -1 for last day of the month."
                    }
                }
            }
        }
    }
}

Nested Schema : DaysOfMonth

Type: object

List of days of month in range 1-31 or -1 for last day of the month.

Show Source

daysOfMonth: array daysOfMonth

List of days of the month (1 based).

{
    "type":"object",
    "description":"List of days of month in range 1-31 or -1 for last day of the month.",
    "properties":{
        "daysOfMonth":{
            "type":"array",
            "description":"List of days of the month (1 based).",
            "items":{
                "type":"integer"
            },
            "example":[
                "1",
                "15"
            ]
        }
    }
}

Nested Schema : DaysOfWeek

Type: object

List of days of week.

Show Source

daysOfWeek: array daysOfWeek

List of days of week (localized short names).

{
    "type":"object",
    "description":"List of days of week.",
    "properties":{
        "daysOfWeek":{
            "type":"array",
            "description":"List of days of week (localized short names).",
            "items":{
                "type":"string",
                "enum":[
                    "MO",
                    "TU",
                    "WE",
                    "TH",
                    "FR",
                    "SA",
                    "SU"
                ]
            },
            "example":[
                "MO",
                "TH"
            ]
        }
    }
}

Nested Schema : EveryNWeeks

Type: object

Repeat every n weeks.

Show Source

everyNWeeks: integer

Repeat interval in weeks.

Example: 2

{
    "type":"object",
    "description":"Repeat every n weeks.",
    "properties":{
        "everyNWeeks":{
            "type":"integer",
            "description":"Repeat interval in weeks.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNDays

Type: object

Repeat every n days.

Show Source

everyNDays: integer

Repeat interval in days, minimal value is 1.

Example: 5

{
    "type":"object",
    "description":"Repeat every n days.",
    "properties":{
        "everyNDays":{
            "type":"integer",
            "description":"Repeat interval in days, minimal value is 1.",
            "example":"5"
        }
    }
}

Nested Schema : EveryNHours

Type: object

Repeat every n hours.

Show Source

everyNHours: integer

Repeat interval in hours.

Example: 2

{
    "type":"object",
    "description":"Repeat every n hours.",
    "properties":{
        "everyNHours":{
            "type":"integer",
            "description":"Repeat interval in hours.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNMinutes

Type: object

Repeat every n minutes, minimal value is 2.

Show Source

everyNMinutes: integer

Repeat interval in minutes.

Example: 45

{
    "type":"object",
    "description":"Repeat every n minutes, minimal value is 2.",
    "properties":{
        "everyNMinutes":{
            "type":"integer",
            "description":"Repeat interval in minutes.",
            "example":"45"
        }
    }
}

Nested Schema : daysOfYear

Type: array

List of days of the year.

Show Source

Array of: object items

{
    "type":"array",
    "description":"List of days of the year.",
    "items":{
        "type":"object",
        "properties":{
            "month":{
                "type":"integer",
                "description":"Month in range of 1-12."
            },
            "day":{
                "type":"integer",
                "description":"Day in range 1-31 or -1 for last day of the month."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

day: integer

Day in range 1-31 or -1 for last day of the month.
month: integer

Month in range of 1-12.

{
    "type":"object",
    "properties":{
        "month":{
            "type":"integer",
            "description":"Month in range of 1-12."
        },
        "day":{
            "type":"integer",
            "description":"Day in range 1-31 or -1 for last day of the month."
        }
    }
}

Nested Schema : daysOfMonth

Type: array

List of days of the month (1 based).

Show Source

Array of: integer

{
    "type":"array",
    "description":"List of days of the month (1 based).",
    "items":{
        "type":"integer"
    },
    "example":[
        "1",
        "15"
    ]
}

Example:

[
    "1",
    "15"
]

Nested Schema : daysOfWeek

Type: array

List of days of week (localized short names).

Show Source

Array of: string

Allowed Values: [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ]

{
    "type":"array",
    "description":"List of days of week (localized short names).",
    "items":{
        "type":"string",
        "enum":[
            "MO",
            "TU",
            "WE",
            "TH",
            "FR",
            "SA",
            "SU"
        ]
    },
    "example":[
        "MO",
        "TH"
    ]
}

Example:

[
    "MO",
    "TH"
]

Nested Schema : next

Match All

Link to the next page in the result set.

Show Source

object Link

A link referencing a REST API.
Link to the next page in the result set.
Example: { "href":"/em/api/blackouts?page=THE_NEXT_PAGE_TOKEN" }

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

Nested Schema : previous

Match All

Link to the previous page in the result set.

Show Source

object Link

A link referencing a REST API.
Link to the previous page in the result set.
Example: { "href":"/em/api/blackouts?page=THE_PREVIOUS_PAGE_TOKEN" }

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

Nested Schema : self

Match All

Link to the current page in the result set.

Show Source

object Link

A link referencing a REST API.
Link to the current page in the result set.
Example: { "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN" }

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

Examples

400 Response

in the case of illegal arguments like unsupported sort direction

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

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

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

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"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

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"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

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}