Skip to content

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 comment.
commentedBy String ID of a user who 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 Integer The ID of a state in which the entity was when it generated an incident.
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 section for more information.
reason.code Integer The condition that caused the state change. See the Reason Codes section.
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.

Reason

Reason Codes

Code Reason
- No reason for a state change. Used for the Created state.
1 Deprecated. Now treated as code 10. If parent's state priority is less than that of a current object, propagate the current object state.
2 Deprecated. Now treated as code 10. If parent's state priority is greater than that of a current object, propagate the sibling with greatest priority.
3 No suitable condition.
4 Sensor error.
5 No children left.
6 No data from agent.
7 Agent down.
8 Monitoring is disabled.
9 Agent task removed.
10 State change in the child object.
11 No data from agent.
12 External change.
13 Manual change.
14 Periodic event was triggered on an object with no data.
15 Data Expiration.
16 Change state on the incident clearing.

Root-cause transition

Root cause indicates that transition is caused by a child element.

Field Type Description
rootCause.entityId String Entity ID.
rootCause.entityType Integer The type of entity.
rootCause.entityName String Name of the entity.
data Object Additional information about the state change reason. Depends on the state change reason.

Branch

Field Type Description
branch.condition Object Condition under which the entity transfers state. See supported operators below and the format below.
branch.state Integer The state to which the entity transfers if the condition is met.
branch.description String Description of the incident generation condition.

Logical operator format.

"operator": "value"

Supported operators:

Field Description
_ct Contains
_eq Equal to
_gt Greater than
_gte Greater than or equal to
_lt Less than
_lte Less than or equal to
_m Matches with
_nct Not contains
_neq Not equal to