Zabbix Documentation 3.4

3.04.04.24.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.4Guidelines

User Tools

Site Tools


manual:api:reference: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:api:reference:event:get [2016/11/29 13:28]
127.0.0.1 external edit
manual:api:reference:event:get [2019/01/28 14:50] (current)
sasha <code js> => <code java>
Line 6: Line 6:
  
 The method allows to retrieve events according to the given parameters. The method allows to retrieve events according to the given parameters.
 +
  
 ==== Parameters ==== ==== Parameters ====
Line 24: Line 25:
 | acknowledged | boolean | If set to ''​true''​ return only acknowledged events. | | acknowledged | boolean | If set to ''​true''​ return only acknowledged events. |
 | severities | integer/​array | Return only events with given trigger severities. Applies only if object is trigger. | | severities | integer/​array | Return only events with given trigger severities. Applies only if object is trigger. |
-| tags | object | Return only events with given tags. Exact match by tag and case-insensitive search by value. \\ Format: ''<​nowiki>​[{"​tag":​ "<​tag>",​ "​value":​ "<​value>"​},​ ...]</​nowiki>''​.\\ An empty array returns all events. |+| tags       ​| object | Return only events with given tags. Exact match by tag and case-insensitive search by value. \\ Format: ''<​nowiki>​[{"​tag":​ "<​tag>",​ "​value":​ "<​value>"​},​ ...]</​nowiki>''​.\\ An empty array returns all events. |
 | eventid_from | string | Return only events with IDs greater or equal to the given ID. | | eventid_from | string | Return only events with IDs greater or equal to the given ID. |
 | eventid_till | string | Return only events with IDs less or equal to the given ID. | | eventid_till | string | Return only events with IDs less or equal to the given ID. |
Line 38: Line 39:
 ^ ||| ^ |||
 | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​eventid'',​ ''​objectid''​ and  ''​clock''​. | | sortfield | string/​array | Sort the result by the given properties. \\ \\ Possible values are: ''​eventid'',​ ''​objectid''​ and  ''​clock''​. |
-| countOutput |flag|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]] page.  |+| countOutput |boolean|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]] page.  |
 | editable |boolean|:::​| | editable |boolean|:::​|
-| excludeSearch |flag|:::|+| excludeSearch |boolean|:::|
 | filter | object |:::| | filter | object |:::|
 | limit |integer|:::​| | limit |integer|:::​|
 | output |query|:::| | output |query|:::|
-| preservekeys |flag|:::|+| preservekeys |boolean|:::|
 | search | object |:::| | search | object |:::|
 | searchByAny |boolean|:::​| | searchByAny |boolean|:::​|
 | searchWildcardsEnabled |boolean|:::​| | searchWildcardsEnabled |boolean|:::​|
 | sortorder | string/​array | ::: | | sortorder | string/​array | ::: |
-| startSearch |flag|:::|+| startSearch |boolean|:::|
 ==== Return values ==== ==== Return values ====
  
Line 63: Line 64:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 70: Line 71:
         "​output":​ "​extend",​         "​output":​ "​extend",​
         "​select_acknowledges":​ "​extend",​         "​select_acknowledges":​ "​extend",​
 +        "​selectTags":​ "​extend",​
         "​objectids":​ "​13926",​         "​objectids":​ "​13926",​
         "​sortfield":​ ["​clock",​ "​eventid"​],​         "​sortfield":​ ["​clock",​ "​eventid"​],​
Line 80: Line 82:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 92: Line 94:
                     "​clock":​ "​1350640590",​                     "​clock":​ "​1350640590",​
                     "​message":​ "​Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",​                     "​message":​ "​Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",​
-                    "​alias":​ "​Admin"​+                    "​alias":​ "Admin", 
 +                    "​name":​ "​Zabbix",​ 
 +                    "​surname":​ "​Administrator"
                 }                 }
             ],             ],
Line 144: Line 148:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 161: Line 165:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​