graphitem.get

Description

integer/array graphitem.get(object parameters)

The method allows to retrieve graph items according to the given parameters.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

ParameterTypeDescription
graphidsstring/arrayReturn only graph items that belong to the given graphs.
itemidsstring/arrayReturn only graph items with the given item IDs.
typeintegerReturn only graph items with the given type.

Refer to the graph item object page for a list of supported graph item types.
selectGraphsqueryReturn a graphs property with an array of graphs that the item belongs to.
sortfieldstring/arraySort the result by the given properties.

Possible values are: gitemid.
countOutputbooleanThese parameters being common for all get methods are described in detail in the reference commentary page.
editableboolean
limitinteger
outputquery
preservekeysboolean
sortorderstring/array

Return values

(integer/array) Returns either:

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

Examples

Retrieving graph items from a graph

Retrieve all graph items used in a graph with additional information about the item and the host.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "graphitem.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "graphids": "387"
  7.            },
  8.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.            "id": 1
  10.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "gitemid": "1242",
  6.                    "graphid": "387",
  7.                    "itemid": "22665",
  8.                    "drawtype": "1",
  9.                    "sortorder": "1",
  10.                    "color": "FF5555",
  11.                    "yaxisside": "0",
  12.                    "calc_fnc": "2",
  13.                    "type": "0",
  14.                    "key_": "system.cpu.util[,steal]",
  15.                    "hostid": "10001",
  16.                    "flags": "0",
  17.                    "host": "Linux"
  18.                },
  19.                {
  20.                    "gitemid": "1243",
  21.                    "graphid": "387",
  22.                    "itemid": "22668",
  23.                    "drawtype": "1",
  24.                    "sortorder": "2",
  25.                    "color": "55FF55",
  26.                    "yaxisside": "0",
  27.                    "calc_fnc": "2",
  28.                    "type": "0",
  29.                    "key_": "system.cpu.util[,softirq]",
  30.                    "hostid": "10001",
  31.                    "flags": "0",
  32.                    "host": "Linux"
  33.                },
  34.                {
  35.                    "gitemid": "1244",
  36.                    "graphid": "387",
  37.                    "itemid": "22671",
  38.                    "drawtype": "1",
  39.                    "sortorder": "3",
  40.                    "color": "009999",
  41.                    "yaxisside": "0",
  42.                    "calc_fnc": "2",
  43.                    "type": "0",
  44.                    "key_": "system.cpu.util[,interrupt]",
  45.                    "hostid": "10001",
  46.                    "flags": "0",
  47.                    "host": "Linux"
  48.                }
  49.            ],
  50.            "id": 1
  51.        }

See also

Source

CGraphItem::get() in ui/include/classes/api/services/CGraphItem.php.