機械翻訳について

移動先

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

電子メール通知構成の設定

put

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

このサービス・インスタンスの電子メール通知構成を更新してください。 この構成を更新するには、管理者としてログインする必要があります。

リクエスト

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

• application/json
• application/xml

本文 ()

リクエスト本文は、このサービス・インスタンスに電子メール通知を設定する詳細を定義します。

ルート・スキーマ : SetNotificationEmailRequest

タイプ: object

電子メール通知構成リクエストを設定します。

ソースを表示

• disableEmailNotifications(optional): string
  電子メール通知を無効にする必要がある場合は、trueに設定します。 それ以外の場合は、falseに設定します。

{
    "description":"Set email notification configuration request.",
    "properties":{
        "disableEmailNotifications":{
            "type":"string",
            "description":"Set to <code>true</code> if email notification needs to be disabled. Set to <code>false</code> otherwise."
        }
    }
}

リクエストの例(application/json)

{
    "disableEmailNotifications":"true"
}

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ : SetNotificationEmailResponse

タイプ: object

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

ソースを表示

• errorCode(optional): number
  エラー・コードがゼロ(0)の場合は、エラーなしです
• type(optional): string
  アイテム・タイプconfig。

{
    "description":"Set email notification configuration response.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>config</code>."
        }
    }
}

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

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

400レスポンス

入力値が無効であるか、リクエストされた値が変更されませんでした。

403レスポンス

ユーザーに管理ロールがない場合は禁止されています。

トップに戻る

例

次の例では、このサービス・インスタンスの電子メール通知を無効にします。

PUT .../config/notification/email

リクエスト・ヘッダー

なし。

リクエスト本文

{
   "disableEmailNotifications": "true"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
   "errorCode":"0",
   "type":"config"

先頭に戻る