システム設定（通知）変更

システム設定の通知設定情報を変更するためのAPIです。Manager画面右上のユーザー名のボタンから［システム設定］を選択した後、［通知］タブを選択したときに表示される画面での操作に相当します。

= 備考 =

次のAPIのレスポンスパラメータは同じです。

  • システム設定（通知）取得API
  • システム設定（通知）変更API
書式
curl -X PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            -d 'JSON形式のリクエストボディ'
            'http://ホスト名:ポート番号/api/v1/system-settings/notifications'
リクエストボディ（JSON形式）
{
  "settings": {
     "agentOfflineSettings": {
        "enableNotification": true,
        "offlineTime": 0
     },
     "mailSettings": {
        "address": "string",
        "cc": "string",
        "enableNotification": true,
        "subjectPrefix": "string"
     },
     "receiveLogErrorSettings": {
        "enableNotification": true
     },
     "termKeyExpirationSettings": {
        "enableNotification": true,
        "beforeDays": 0
     },
     "traceLogErrorSettings": {
        "enableNotification": true
     },
     "transferLogErrorSettings": {
        "enableNotification": true
     }
  }
}
リクエストパラメータ（JSON形式）
項目名 リクエストパラメータ 型 値 省略値

エージェントオフライン通知

(ON/OFF)

 settings agentOfflineSettings enableNotification 論理型

•　true：On

•　false：Off

  

エージェントオフライン通知の閾値

 offlineTime 数値

0　~　59　（単位は分）

エージェントとのセッションが何分間オフラインになった場合にメールを送信するか、指定します。

  

宛先

(To)

 mailSettings address 文字列

256文字以下のASCII文字

RFC準拠のメールアドレスを、カンマ（,）で区切って指定できます。

次のいずれかの形式で指定してください。

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

 mailSettingsのenableNotificationがtrue、かつ宛先を一度も登録したことがない場合に省略不可

宛先

(cc)

 cc 文字列

256文字以下のASCII文字

RFC準拠のメールアドレスを、カンマ（,）で区切って指定できます。

次のいずれかの形式で指定してください。

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

  

メール送信

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off

  
件名のプレフィックス subjectPrefix 文字列

通知メールの件名の先頭に追加する文字列を指定できます。

20文字以下

  

受信履歴エラー通知

(ON/OFF)

 receiveLogErrorSettings enableNotification 論理型

•　true：On

•　false：Off

  

利用期間ライセンスキー更新通知

(ON/OFF)

 termKeyExpirationSettings enableNotification 論理型

•　true：On

•　false：Off

  

利用期間ライセンスキー更新通知の閾値

 beforeDays 文字列

有効期限の何日前に通知メールを送信するか、指定します。

1　~　30（単位は日）

  

トレースログエラー通知

(ON/OFF)

 traceLogErrorSettings enableNotification 論理型

•　true：On

•　false：Off

  

転送履歴エラー通知

(ON/OFF)

 transferLogErrorSettings enableNotification 論理型

•　true：On

•　false：Off

  
レスポンス
{
  "settings": {
     "agentOfflineSettings": {
        "cron": "string",
        "enableNotification": true,
        "offlineTime": 0
     },
     "mailSettings": {
        "address": "string",
        "cc": "string",
        "enableNotification": true,
        "subjectPrefix": "string"
     },
     "receiveLogErrorSettings": {
        "cron": "string",
        "enableNotification": true
     },
     "termKeyExpirationSettings": {
        "beforeDays": 0,
        "cron": "string",
        "enableNotification": true
     },
     "traceLogErrorSettings": {
        "cron": "string",
        "enableNotification": true
     },
     "transferLogErrorSettings": {
        "cron": "string",
        "enableNotification": true
     }
  }
}
レスポンスパラメータ

レスポンスパラメータについては、「システム設定（通知）取得」の「レスポンスパラメータ」を参照してください。