GET /api/mail_notifications
電子メール通知の一覧

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
description
name
user

GET /api/mail_notifications/:id
電子メール通知の表示

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

数値 ID または電子メール通知名

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/users/:user_id/mail_notifications
Add an email notification for a user

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
必須

Validations:

  • Must be a String

mail_notification_id
必須

Validations:

  • Must be a Integer

interval
任意

Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

Validations:

  • Must be a String

subscription
任意

Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

Validations:

  • Must be a String

mail_query
任意

Relevant only for audit summary notification

Validations:

  • Must be a String


PUT /api/users/:user_id/mail_notifications/:mail_notification_id
Update an email notification for a user

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
必須

Validations:

  • Must be a String

mail_notification_id
必須

Validations:

  • Must be a Integer

interval
任意

Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification

Validations:

  • Must be a String

subscription
任意

Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state

Validations:

  • Must be a String

mail_query
任意

Relevant only for audit summary notification

Validations:

  • Must be a String


DELETE /api/users/:user_id/mail_notifications/:mail_notification_id
Remove an email notification for a user

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
必須

Validations:

  • Must be a String

mail_notification_id
必須

Validations:

  • Must be a Integer


GET /api/users/:user_id/mail_notifications
List all email notifications for a user

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
必須

Validations:

  • Must be a String