Table of Contents
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.
| Parameter | Type | Description |
|---|---|---|
| graphids | ID/array | Return only graph items that belong to the given graphs. |
| itemids | ID/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. |
| selectGraphs | query | Return a graphs property with an array of graphs that the item belongs to. |
| sortfield | string/array | Sort the result by the given properties. Possible values: gitemid. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary page. |
| editable | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| 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.
{
"jsonrpc": "2.0",
"method": "graphitem.get",
"params": {
"output": "extend",
"graphids": "387"
},
"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"
},
{
"gitemid": "1243",
"graphid": "387",
"itemid": "22668",
"drawtype": "1",
"sortorder": "2",
"color": "55FF55",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0"
},
{
"gitemid": "1244",
"graphid": "387",
"itemid": "22671",
"drawtype": "1",
"sortorder": "3",
"color": "009999",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0"
}
],
"id": 1
}See also
Source
CGraphItem::get() in ui/include/classes/api/services/CGraphItem.php.