Jump to

• Request
• Response

Add SMTP Configuration

put

/essbase/rest/v1/email/smtp

Configure SMTP e-mail server information. IMAP is the protocol used for receiving e-mails related to scenario management workflow and approval.

Request

Supported Media Types

• application/json
• application/xml

Body ()

SMTP server configuration details. Provide the host name, port, user e-mail address, and encoded password.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

The e-mail configuration was updated successfully.

Body ()

Root Schema : ListLinkResponseObject

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top