システム設定（通知）取得

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

= 備考 =

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

  • システム設定（通知）取得API
  • システム設定（通知）変更API
書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/system-settings/notifications'
リクエストパラメータ
リクエストパラメータは不要です。
レスポンス
{
  "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
     }
  }
}
レスポンスパラメータ
項目名 レスポンスパラメータ 型 値
エージェントオフライン通知のスケジュール settings agentOfflineSettings cron 文字列

"秒 分 時 日 月 曜日"（例：0 0 10-18 * * MON-FRI）

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

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

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off

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

 offlineTime 数値

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

宛先

(To)

 mailSettings address 文字列  

宛先

(Cc)

 cc 文字列  

メール送信

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off
件名のプレフィックス subjectPrefix 文字列  
受信履歴エラー通知のスケジュール

receiveLogErrorSettings

 cron 文字列

"秒 分 時 日 月 曜日"（例：0 0 10-18 * * MON-FRI）

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

受信履歴エラー通知

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off

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

 termKeyExpirationSettings beforeDays 数値 有効期限の何日前にメールを送信するか、返却されます。
利用期間ライセンスキー更新通知のスケジュール cron 文字列

"秒 分 時 日 月 曜日"（例：0 0 10-18 * * MON-FRI）

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

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

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off
トレースログエラー通知のスケジュール traceLogErrorSettings cron 文字列

"秒 分 時 日 月 曜日"（例：0 0 10-18 * * MON-FRI）

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

トレースログエラー通知

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off
転送履歴エラー通知のスケジュール transferLogErrorSettings cron 文字列

"秒 分 時 日 月 曜日"（例：0 0 10-18 * * MON-FRI）

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

転送履歴エラー通知

(ON/OFF)

 enableNotification 論理型

•　true：On

•　false：Off