Mail notifications

>>>

GET /api/mail_notifications
Liste des notifications par courrier électronique

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
description
name
user
>>>

GET /api/mail_notifications/:id
Voir une notification par courrier électronique

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
id
requis

ID numérique ou nom de la notification par courrier électronique

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
user_id
requis

Validations:

  • Must be a String
mail_notification_id
requis

Validations:

  • Must be a Integer
interval
optionel

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

Validations:

  • Must be a String
subscription
optionel

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
optionel

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
user_id
requis

Validations:

  • Must be a String
mail_notification_id
requis

Validations:

  • Must be a Integer
interval
optionel

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

Validations:

  • Must be a String
subscription
optionel

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
optionel

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
user_id
requis

Validations:

  • Must be a String
mail_notification_id
requis

Validations:

  • Must be a Integer
>>>

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer
user_id
requis

Validations:

  • Must be a String