移動先

• リクエスト
• レスポンス

IMAP構成の追加

put

/essbase/rest/v1/email/imap

IMAP電子メール・サーバー情報を構成します。IMAPは、Essbaseでシナリオ管理のワークフローおよび承認に関連する電子メールの送信に使用されるプロトコルです。

リクエスト

サポートされているメディア・タイプ

• application/json
• application/xml

本体()

IMAPサーバー構成の詳細。ホスト名、ポート、ユーザーの電子メール・アドレスおよびエンコードされたパスワードを提供します。

ルート・スキーマ : ServerConfiguration

型: object

ソースの表示

• folder: string
• host: string
• messageAction: string
• messageLocation: string
• password: string
• port: integer(int32)
• user: 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"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

電子メール構成が正常に更新されました。

本体()

ルート・スキーマ : ListLinkResponseObject

型: object

ソースの表示

• links: array links

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

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

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

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

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

400 レスポンス

不正なリクエスト

ログイン・ユーザーは、このリクエストを実行するにはサービス管理者である必要があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る