Alert Definition
| Name | Type | Required | Meaning |
|---|---|---|---|
| id | int | For Updates | A unique identifying integer. |
| organizationId | int | Yes | The unique ID of the organization the alert belongs to. Must be greater than zero. |
| accountId | int | No | The unique ID of the account the alert belongs to. |
| siteId | int | No | The unique ID of the site the alert belongs to. |
| machineId | int | Yes | The unique ID of the machine the alert belongs to. Must be greater than zero. |
| machineLocation | string | No | The name of the machine that raised the alert. |
| machineProse | string? | No | Read only. The prose of the machine that raised the alert. |
| alertCodeId | int | Yes | The ID of the code this alert is associated with. Must be greater than zero. |
| code | string | No | A shorthand identifier for the alerts message. |
| message | string | No | A user friendly description of the issue the alert represents. Defaulted from the alert code when omitted. |
| isCleared | bool | * | Indicates if the alert has already been cleared. |
| clearedAt | DateTime? | * | A UTC date time string indicating when the alert was cleared. |
| raisedAt | DateTime? | Yes | A UTC date time string indicating when the alert was raised by our system. |
| alertMetadata | alertMetadata[] | No | An optional list of alertMetadata. If specified while creating alerts, the alert metadata will also be created and associated with this alert. Will always be an empty list when retrieving alerts. |
| timeZone | string | No | The timezone of the site the alert was raised at. Read only. |
Notice
* - You are required to specify one or both of these.