5.335 Fields: Notifications
See the associated Notifications resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | notifications | Permissions |
| Hooks filename | notifications.groovy | Pre- and Post-Processing Hooks |
| Distinct query-supported | Yes | Distinct |
API version 3
Notifications, while related to Events, are used for different purposes. See NotificationCondition for more information on when notifications should be used as opposed to events.
Notifications are a per-user representation of all notification conditions present in the system at any one time. When an administrator or user requests this resource, notifications are automatically created from the notification conditions that they have access to (determined by the Notification.tenant or the NotificationCondition.escalationLevel fields). Notifications are expected to contain messages and details that may be understood by a user or admin depending on the escalation level, and contain fields that control whether the user or admin will be notified of future updates to their corresponding condition. Notifications cannot be deleted, but they can be marked as ignored (see Notification.ignoredDate or dismissed (see Notification.dismissedDate).| Field Name | Type | PUT | Description |
|---|---|---|---|
| id | String | No |
The identifier of the notification. |
| conditionId | String | No |
The identifier of the NotificationCondition from which this notification was created. |
| createdDate | Date | No |
The date that the notification condition first appeared. |
| details | Map<String, Map> | No |
Arbitrary storage of details for this notification. This could include "pluginType", "pluginId", etc. |
| dismissedDate | Date | No |
The date that the notification was dismissed by a user or admin, meaning that they acknowledged the notification and wanted to know of future updates to this notification. This field is cleared every time the attached notification condition is updated/observed again. (See also: conditionId.) |
| ignoredDate | Date | No |
The date that the notification was ignored by a user or admin, meaning that they acknowledged the notification now and in the future and did not wish to know of any updates. This field is never cleared, even if the attached notification condition is updated/observed again. |
| message | String | No |
A message detailing the notification and why it exists, with possible action items. |
| objectId | String | No |
The identifier of the object which this notification affects, such as "node1" or "vm1". |
| objectType | String | No |
The object type that this notification affects, such as "Node", "VM", "System", etc. |
| observedDate | Date | No |
The latest date that the notification condition was observed. If this field, ignoredDate, and dismissedDate are not set during an update (i.e. a user/admin is not ignoring or dismissing the notification), this field will automatically be set to the current date. |
| origin | String | No |
The origin of the notification. |
| user | String | No |
The user that this notification was created for. |
Related Topics