Mail notifications

>>>

GET /api/mail_notifications
Lista adresów e-mail do powiadamiania

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String
order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.
per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
description
name
user
>>>

GET /api/mail_notifications/:id
Pokaż mailowe powiadomienia

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

ID numeryczne lub adres e-mail do notyfikacji

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
wymagany

Validations:

  • Must be a String
mail_notification_id
wymagany

Validations:

  • Must be a Integer
interval
opcjonalny

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

Validations:

  • Must be a String
subscription
opcjonalny

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
opcjonalny

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
wymagany

Validations:

  • Must be a String
mail_notification_id
wymagany

Validations:

  • Must be a Integer
interval
opcjonalny

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

Validations:

  • Must be a String
subscription
opcjonalny

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
opcjonalny

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
wymagany

Validations:

  • Must be a String
mail_notification_id
wymagany

Validations:

  • Must be a Integer
>>>

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
wymagany

Validations:

  • Must be a String