Jump to

• Request
• Response

Delete the blackout with the given id

delete

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

This API deletes an existing blackout for the given id. The blackout has to be ended or stopped before.

Request

Path Parameters

• blackoutId(required): string
  blackout id

There's no request body for this operation.

Back to Top

Response

204 Response

Blackout got deleted

401 Response

Client is not authenticated.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

404 Response

Resource not found or not authorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

413 Response

Blackout is in invalid state.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

500 Response

Internal error serving the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

503 Response

Indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

Back to Top