Table of Contents
graphitem.get
Description
integer/array graphitem.get(object parameters)
The method allows to retrieve graph items according to the given parameters.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| gitemids | string/array | Return only graph items with the given IDs. |
| graphids | string/array | Return only graph items that belong to the given graphs. |
| itemids | string/array | Return only graph items with the given item IDs. |
| type | integer | Return only graph items with the given type. Refer to the graph item object page for a list of supported graph item types. |
| expandData | flag | Return additional data about the item and the host. Adds the following properties to each graph item: key_ - (string) key of the item;hostid - (string) ID of the host;flags - (string) origin of the item;host - (string) technical name of the host. |
| selectGraphs | query | Return the graph that the item belongs to as an array in the graphs property. |
| sortfield | string/array | Sort the result by the given properties. Possible values are: gitemid. |
| countOutput | flag | These parameters being common for all get methods are described in detail in the reference commentary page. |
| editable | boolean | |
| limit | integer | |
| nodeids | string/array | |
| output | query | |
| preservekeys | flag | |
| sortorder | string/array |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter 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:
{
"jsonrpc": "2.0",
"method": "graphitem.get",
"params": {
"output": "extend",
"expandData": 1,
"graphids": "387"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"gitemid": "1242",
"graphid": "387",
"itemid": "22665",
"drawtype": "1",
"sortorder": "1",
"color": "FF5555",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0",
"key_": "system.cpu.util[,steal]",
"hostid": "10001",
"flags": "0",
"host": "Template OS Linux"
},
{
"gitemid": "1243",
"graphid": "387",
"itemid": "22668",
"drawtype": "1",
"sortorder": "2",
"color": "55FF55",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0",
"key_": "system.cpu.util[,softirq]",
"hostid": "10001",
"flags": "0",
"host": "Template OS Linux"
},
{
"gitemid": "1244",
"graphid": "387",
"itemid": "22671",
"drawtype": "1",
"sortorder": "3",
"color": "009999",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0",
"key_": "system.cpu.util[,interrupt]",
"hostid": "10001",
"flags": "0",
"host": "Template OS Linux"
}
],
"id": 1
}See also
Source
CGraphItem::get() in frontends/php/api/classes/CGraphItem.php.