manual:api:reference:trigger:object

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
manual:api:reference:trigger:object [2014/09/25 14:43]
sasha Page moved from 2.4:manual:api:reference:trigger:object to manual:api:reference:trigger:object
manual:api:reference:trigger:object [2021/04/01 10:26] (current)
vmaksimovs [ZBXNEXT-6141] fixed event name description
Line 7: Line 7:
 The trigger object has the following properties. The trigger object has the following properties.
  
-^  Property ​ ^  Type  ^  Description ​ ^+^  Property ​ ^  ​[[:​manual/​api/​reference_commentary#​data_types|Type]]  ​^ ​ Description ​ ^
 | triggerid ​ | string ​ | //​(readonly)//​ ID of the trigger. ​ | | triggerid ​ | string ​ | //​(readonly)//​ ID of the trigger. ​ |
 | **description** \\ (required) | string | Name of the trigger. | | **description** \\ (required) | string | Name of the trigger. |
 | **expression** \\ (required) | string | Reduced trigger expression. | | **expression** \\ (required) | string | Reduced trigger expression. |
-| comments | string | Additional ​comments to the trigger. |+| event_name | string | Event name generated by the trigger. | 
 +| opdata ​  | string | Operational data. | 
 +| comments | string | Additional ​description of the trigger. |
 | error | string | //​(readonly)//​ Error text if there have been any problems when updating the state of the trigger. | | error | string | //​(readonly)//​ Error text if there have been any problems when updating the state of the trigger. |
 | flags | integer | //​(readonly)//​ Origin of the trigger. \\ \\ Possible values are: \\ 0 - //​(default)//​ a plain trigger; \\ 4 - a discovered trigger. | | flags | integer | //​(readonly)//​ Origin of the trigger. \\ \\ Possible values are: \\ 0 - //​(default)//​ a plain trigger; \\ 4 - a discovered trigger. |
Line 22: Line 24:
 | url | string | URL associated with the trigger. | | url | string | URL associated with the trigger. |
 | value | integer | //​(readonly)//​ Whether the trigger is in OK or problem state. \\ \\ Possible values are: \\ 0 - //​(default)//​ OK; \\ 1 - problem. | | value | integer | //​(readonly)//​ Whether the trigger is in OK or problem state. \\ \\ Possible values are: \\ 0 - //​(default)//​ OK; \\ 1 - problem. |
 +| recovery_mode | integer | OK event generation mode. \\ \\ Possible values are: \\ 0 - //​(default)//​ Expression; \\ 1 - Recovery expression; \\ 2 - None.|
 +| recovery_expression | string | Reduced trigger recovery expression. |
 +| correlation_mode | integer | OK event closes. \\ \\ Possible values are: \\ 0 - //​(default)//​ All problems; \\ 1 - All problems if tag values match.|
 +| correlation_tag | string | Tag for matching. |
 +| manual_close | integer | Allow manual close. \\ \\ Possible values are: \\ 0 - //​(default)//​ No; \\ 1 - Yes.|
 +
 +==== Trigger tag ====
 +
 +The trigger tag object has the following properties.
 +
 +^  Property ​            ^ [[:​manual/​api/​reference_commentary#​data_types|Type]] ​   ^ Description ​       ^
 +| **tag** \\ (required) | string ​ | Trigger tag name.  |
 +| value                 | string ​ | Trigger tag value. |