Jump to

• Request
• Response

Create a new blackout reason.

post

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

This API creates a new user defined blackout reason

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload to create a new blackout reason.

Match All

Payload to create a new blackout reason.

Show Source

• object Reason
  Reason of a blackout.

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Payload to create a new blackout reason.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

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."
        }
    }
}

Examples

Select an example Create a blackout reason

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

Body ()

Root 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

A single blackout reason.

A single blackout reason.

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."
        }
    }
}

Examples

Select an example Result - Create a new blackout reason

400 Response

One of the given parameters is invalid.

Body ()

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.

Body ()

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"
        }
    }
}

409 Response

Not authorized or resource already exists.

Body ()

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.

Body ()

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.

Body ()

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"
        }
    }
}

Back to Top