機械翻訳について

移動先

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

電子メール通知構成の取得

get

/documents/api/1.2/config/notification/email

このサービス・インスタンスの電子メール通知構成を取得します。

リクエスト

この操作のリクエスト・パラメータはありません。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

本文 ()

ルート・スキーマ : GetNotificationEmailResponse

タイプ: object

電子メール通知構成のレスポンスを取得します。

ソースを表示

• disableEmailNotifications(optional): string
  電子メール通知が無効になっている場合は、trueを返します。 それ以外の場合はfalseを返します
• errorCode(optional): number
  エラー・コードがゼロ(0)の場合は、エラーなしです
• type(optional): string
  アイテム・タイプconfig。

{
    "description":"Get email notification configuration response.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "disableEmailNotifications":{
            "type":"string",
            "description":"Returns <code>true</code> if email notification is disabled. Returns <code>false</code> otherwise."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>config</code>."
        }
    }
}

レスポンスの例(application/json)

{
    "errorCode":"0",
    "disableEmailNotifications":"false",
    "type":"config"
}

トップに戻る

例

次の例では、このサービス・インスタンスの電子メール通知構成を取得します。

GET .../config/notification/email

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
   "errorCode":"0",
   "disableEmailNotifications":"false",
   "type":"config"
}

先頭に戻る