Jump to

• Request
• Response

Get IMAP Configuration

get

/essbase/rest/v1/email/imap

Returns IMAP server configuration details. IMAP is the protocol Essbase uses for sending e-mails related to scenario management workflow and approval.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

The e-mail configuration was retrieved successfully.

Body ()

Root Schema : ServerConfiguration

Type: object

Show Source

• folder(optional): string
• host(optional): string
• messageAction(optional): string
• messageLocation(optional): string
• password(optional): string
• port(optional): integer(int32)
• user(optional): string

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string"
        },
        "port":{
            "type":"integer",
            "format":"int32"
        },
        "user":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "folder":{
            "type":"string"
        },
        "messageAction":{
            "type":"string"
        },
        "messageLocation":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Logged in user must be a service administrator to execute this request.

404 Response

Not Found

The e-mail configuration is not present.

500 Response

Internal Server Error.

Back to Top