Jump to

• Request
• Response

List blackouts affecting a target by target ID

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/targets/{targetId}

Lists blackouts affecting a target by target ID.

Request

Path Parameters

• targetId(required): string
  the target id

Query Parameters

• 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 directions are ASC and DESC.

  Example:

  name:ASC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ExtendedBlackoutSummaryCollection

Type: object

Collection of extended blackout summaries for a target.

Show Source

• count(required): integer
  Number of items in this page.

  Example: 1
• items(required): array items
  Extended blackout summaries.
• links(required): object links
  Result set navigation links.

{
    "x-em-sdk-level":"emSDK",
    "description":"Collection of extended blackout summaries for a target.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of items in this page.",
            "example":1
        },
        "items":{
            "type":"array",
            "description":"Extended blackout summaries.",
            "items":{
                "$ref":"#/components/schemas/ExtendedBlackoutSummary"
            }
        },
        "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/targets/TARGET_ID?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/targets/TARGET_ID?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/targets/TARGET_ID?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Extended blackout summaries.

Show Source

• Array of: object ExtendedBlackoutSummary
  Extended summary information about a blackout for a specific target.

{
    "type":"array",
    "description":"Extended blackout summaries.",
    "items":{
        "$ref":"#/components/schemas/ExtendedBlackoutSummary"
    }
}

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/targets/TARGET_ID?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/targets/TARGET_ID?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/targets/TARGET_ID?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : ExtendedBlackoutSummary

Type: object

Extended summary information about a blackout for a specific target.

Show Source

• blackoutStatus: 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.
• createdBy: string
  User who created the blackout.
• durationHours: integer
  Duration of the blackout in hours. For indefinite, a negative value may be returned.
• durationMinutes: integer
  Duration of the blackout in minutes.
• id: string
  Blackout ID
• isFullBlackout: string
  Indicates if the blackout is full for this target (YES, NO, NA).
• lastUpdatedBy: string
  User who last updated the blackout.
• links: object links
  Blackout related links.
• name: string
  Blackout Name
• reason: string
  blackout reason
• repeat: object Repeat
  Describes repetition of a blackout.
• status: 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.
• timeToEnd: string
  End time of the blackout occurrence.
• timeToStart: string
  Start time of the blackout occurrence.
• type: string
  Default Value: PATCHING

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

  Type of the blackout.

{
    "x-em-sdk-level":"emSDK",
    "description":"Extended summary information about a blackout for a specific target.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        },
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout occurrence."
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time of the blackout occurrence."
        },
        "durationMinutes":{
            "type":"integer",
            "description":"Duration of the blackout in minutes."
        },
        "durationHours":{
            "type":"integer",
            "description":"Duration of the blackout in hours. For indefinite, a negative value may be returned."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        }
                    ]
                }
            }
        },
        "blackoutStatus":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "reason":{
            "type":"string",
            "description":"blackout reason"
        },
        "isFullBlackout":{
            "type":"string",
            "description":"Indicates if the blackout is full for this target (YES, NO, NA)."
        },
        "createdBy":{
            "type":"string",
            "description":"User who created the blackout."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"User who last updated the blackout."
        }
    }
}

Nested Schema : links

Type: object

Blackout related links.

Show Source

• self: self

{
    "type":"object",
    "description":"Blackout related links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the blackout."
                }
            ]
        }
    }
}

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 : self

Match All

Link to the blackout.

Show Source

• object Link
  A link
• Link to the blackout.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the blackout."
        }
    ]
}

Nested Schema : Link

Type: object

A link

Show Source

• href(required): string
  URL for link

{
    "description":"A link",
    "type":"object",
    "required":[
        "href"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for link"
        }
    }
}

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
• Link to the next page in the result set.
• Example: { "href":"/em/api/blackouts/targets/TARGET_ID?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/targets/TARGET_ID?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
• Link to the previous page in the result set.
• Example: { "href":"/em/api/blackouts/targets/TARGET_ID?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/targets/TARGET_ID?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
• Link to the current page in the result set.
• Example: { "href":"/em/api/blackouts/targets/TARGET_ID?page=THIS_PAGE_TOKEN" }

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

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

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

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

Back to Top