problem.get

Description

integer/array problem.get(object parameters)

The method allows to retrieve problems according to the given parameters.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
eventids string/array Return only problems with the given IDs.
groupids string/array Return only problems created by objects that belong to the given host groups.
hostids string/array Return only problems created by objects that belong to the given hosts.
objectids string/array Return only problems created by the given objects.
applicationids string/array Return only probles created by objects that belong to the given applications. Applies only if object is trigger or item.
source integer Return only problems with the given type. Refer to the problem event object page for a list of supported event types. Default: 0 - problem created by a trigger.
object integer Return only problems created by objects of the given type. Refer to the problem event object page for a list of supported object types. Default: 0 - trigger.
acknowledged boolean true - return acknowledged problems only; false - unacknowledged only.
severities integer/array Return only problems with given trigger severities. Applies only if object is trigger.
tags array of objects Return only problems with given tags. Exact match by tag and case-insensitive search by value. Format: [{"tag": "<tag>", "value": "<value>"}, …].An empty array returns all problems.
recent string true - return PROBLEM and recently RESOLVED problems (depends on Display OK triggers for N seconds) Default: false - UNRESOLVED problems only
eventid_from string Return only problems with IDs greater or equal to the given ID.
eventid_till string Return only problems with IDs less or equal to the given ID.
time_from timestamp Return only problems that have been created after or at the given time.
time_till timestamp Return only problems that have been created before or at the given time.
selectAcknowledges query Return problem's acknowledges in the acknowledges property. Acknowledges are sorted in reverse chronological order. The problem acknowledgement object has the following properties: acknowledgeid - (string) acknowledgement's ID; userid - (string) ID of the user that acknowledged the event; eventid - (string) ID of the acknowledged event; clock - (timestamp) time when the event was acknowledged; message - (string) text of the acknowledgement message; Supports count.
selectTags query Return problem's tags. Output format: [{"tag": "<tag>", "value": "<value>"}, …].
sortfield string/array Sort the result by the given properties. Possible values are: eventid.
countOutput flagThese parameters being common for all get methods are described in detail in the reference commentary page.
editable boolean
excludeSearch flag
filter object
limit integer
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

Return values

(integer/array) Returns either:

  • an array of objects;

  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieving trigger problem events

Retrieve recent events from trigger “15112.”

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "problem.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "selectAcknowledges": "extend",
  7.         "selectTags": "extend",
  8.         "objectids": "15112",
  9.         "recent": "true",
  10.         "sortfield": ["eventid"],
  11.         "sortorder": "DESC"
  12.     },
  13.     "auth": "67f45d3eb1173338e1b1647c4bdc1916",
  14.     "id": 1
  15. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "eventid": "1245463",
  6.             "source": "0",
  7.             "object": "0",
  8.             "objectid": "15112",
  9.             "clock": "1472457242",
  10.             "ns": "209442442",
  11.             "r_eventid": "1245468",
  12.             "r_clock": "1472457285",
  13.             "r_ns": "125644870",
  14.             "correlationid": "0",
  15.             "userid": "1",
  16.             "acknowledges": [
  17.                 {
  18.                     "acknowledgeid": "14443",
  19.                     "userid": "1",
  20.                     "eventid": "1245463",
  21.                     "clock": "1472457281",
  22.                     "message": "problem solved",
  23.                     "action": "1"
  24.                 }
  25.             ],
  26.             "tags": [
  27.                 {
  28.                     "tag": "test tag",
  29.                     "value": "test value"
  30.                 }
  31.             ]
  32.         }
  33.     ],
  34.     "id": 1
  35. }

See also

Source

CEvent::get() in frontends/php/include/classes/api/services/CProblem.php.