Incident
Incidents are special entities that signify a problem with an object, monitored by the entity, and the severity of that problem.
Incidents are generated when entity's Incident Condition or State Conditions are met.
Incidents are cleared when the entity's state is set to 3
or an Incident Condition's clear condition was met.
Field | Type | Description |
---|---|---|
id | String | Incident's ID. |
entityId | String | ID of an entity for which the incident happened. |
data | String | Entity's data. |
acknowledgedBy | String | ID of a user who acknowledged the incident. |
acknowledgementTimestamp | Integer | A timestamp when the incident was acknowledged. |
clearTimestamp | Integer | A timestamp when the incident was cleared. |
comment | String | Incident's last comment. |
commentedBy | String | ID of a user who last commented on the incident. |
commentTimestamp | Integer | A timestamp when the incident was commented. |
entityType | Integer | Type of the entity. It's equal to 1 for objects and 2 for links. |
localTimestamp | Integer | The time the incident occurred. |
parentChainId | String | Origin of a link that triggered an incident. Included only for incidents of type 2 . |
state | String | The ID of the current Incident Level. |
lastState | String | The ID of the Incident Level that the incident had before it has been marked for clearing. |
text | String | Incident's description. |
timestamp | Integer | The timestamp when the incident was registered in the system. |
type | Integer | The type of incident. Possible types are 1 (entity changed state) and 2 (incident generation condition was met). |
branchId | String | Condition branch ID. Included for incidents generated by custom incident conditions. |
reason | Object | Reason for an incident generation. See Reason article for more information. |
reason.code | Integer | ID of the reason for an incident generation. See the Reason Codes section for a list of all reason code. |
reason.data | Object | Additional information about the state change condition. |
reason.rootCause | String | Root-cause transition information. See the Root cause section. |
reason.branch | Object | Condition that triggered the incident. See the Branch section for more information. |
removed | Object | Information about incident removal with the Clear and Remove Incident request. |
removed.userId | Object | ID of a user who removed the incident. |
removed.timestamp | Object | Time of the incident removal. |
owner | Object/Link | Information about the entity that triggered the incident. |
properties | Array<Key-Value Pair> | A list of incident's properties. |