Zabbix Documentation 2.0

3.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.22.43.23.4

User Tools

Site Tools


manual:appendix:api:event:get

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:appendix:api:event:get [2013/01/16 12:31]
Pavels [Parameters] corrected data types
manual:appendix:api:event:get [2019/01/28 14:49] (current)
sasha <code js> => <code java>
Line 18: Line 18:
 | hostids | string/​array | Return only events created by triggers that belong to the given hosts. | | hostids | string/​array | Return only events created by triggers that belong to the given hosts. |
 | triggerids | string/​array | Return only events that have been created by the given triggers. | | triggerids | string/​array | Return only events that have been created by the given triggers. |
-| object | integer | Return only events created by objects of the given type. \\ \\ Refer to the  [[2.0:​manual:​appendix:​api:​event:​definitions#​event|event object page]] for a list of supported object types. | +| object | integer | Return only events created by objects of the given type. \\ \\ Refer to the  [[definitions#​event|event object page]] for a list of supported object types. | 
-| source | integer | Return only events with the given type. \\ \\ Refer to the  [[2.0:​manual:​appendix:​api:​event:​definitions#​event|event object page]] for a list of supported event types. |+| source | integer | Return only events with the given type. \\ \\ Refer to the  [[definitions#​event|event object page]] for a list of supported event types. |
 ^ ||| ^ |||
 | acknowledged | boolean | If set to ''​true''​ return only acknowledged events. | | acknowledged | boolean | If set to ''​true''​ return only acknowledged events. |
Line 35: Line 35:
 ^ ||| ^ |||
 | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​eventid'',​ ''​object''​ and ''​objectid''​. ​ | | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​eventid'',​ ''​object''​ and ''​objectid''​. ​ |
-| countOutput |flag|These parameters being common for all ''​get''​ methods are described in detail on the [[2.0:manual:​appendix:​api:​generic#​common_get_method_parameters|Generic Zabbix API information]] page.  |+| countOutput |flag|These parameters being common for all ''​get''​ methods are described in detail on the [[manual:​appendix:​api:​generic#​common_get_method_parameters|Generic Zabbix API information]] page.  |
 | editable |boolean|:::​| | editable |boolean|:::​|
 | excludeSearch |flag|:::| | excludeSearch |flag|:::|
Line 46: Line 46:
 | searchByAny |boolean|:::​| | searchByAny |boolean|:::​|
 | searchWildcardsEnabled |boolean|:::​| | searchWildcardsEnabled |boolean|:::​|
 +| sortorder | string/​array | ::: |
 | startSearch |flag|:::| | startSearch |flag|:::|
 ==== Return values ==== ==== Return values ====
Line 60: Line 61:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 77: Line 78:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 124: Line 125:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 141: Line 142:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 185: Line 186:
 ==== See also ==== ==== See also ====
  
-  * [[2.0:manual:​appendix:​api:​alert:​definitions|Alert]] +  * [[manual:​appendix:​api:​alert:​definitions|Alert]] 
-  * [[2.0:manual:​appendix:​api:​item:​definitions|Item]] +  * [[manual:​appendix:​api:​item:​definitions|Item]] 
-  * [[2.0:manual:​appendix:​api:​host:​definitions|Host]] +  * [[manual:​appendix:​api:​host:​definitions|Host]] 
-  * [[2.0:manual:​appendix:​api:​trigger:​definitions|Trigger]]+  * [[manual:​appendix:​api:​trigger:​definitions|Trigger]]
  
 ==== Source ==== ==== Source ====
  
 CEvent::​get() in //​frontends/​php/​api/​classes/​CEvent.php//​. CEvent::​get() in //​frontends/​php/​api/​classes/​CEvent.php//​.