Skip to content

Alert

The Alert Object presents an event that the Users should address.

The system can generate alerts internally, through triggers, or manually by API.

An Alert can be create with a flag that indicates if the alert already exists and has not been acknowledge, the existing alert will be used and the count field is updated.

Field

Field Definition
AcknowledgeTime AcknowledgeTime - time of acknowledgement
AcknowledgeUser AcknowledgeUser - user who acknowledged
Acknowledged Acknowledged - has the alert been acknowledged
Contents Contents is the full information about the alert
Count Count is the number of times this Name has been called uniquely
Level Level of the alert
Range of values: Error, Warn, Info, Debug
Name Name is a short name for this alert. This can contain any reference
information for humans you want associated with the alert.
Note Notes - field for additional information about the Alert
Use this field for notes about what is done with the alert.
Params Params - structure of data elements - filterable
Principal Principal is the creator of the alert.
Time Time of the alert.
swagger:strfmt date-time
Uuid The UUID of the alert.
This is auto-created at Create time, and cannot change afterwards.

required: true
swagger:strfmt uuid