Documentation
Table of Contents
graphitem.get
説明
integer/array graphitem.get(object parameters)
このメソッドは、指定したパラメーターに応じたグラフアイテムを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) 希望する出力を定義するパラメータ
このメソッドは、以下のパラメータをサポートしています。
| パラメータ | Type | 説明 |
|---|---|---|
| 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. |
| 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 are: 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 |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
グラフからグラフアイテムの取得
グラフで使用されているすべてのグラフアイテムを、アイテムとホストに関する追加情報とともに取得します。
{ "jsonrpc": "2.0", "method": "graphitem.get", "params": { "output": "extend", "graphids": "387" }, "id": 1 }レスポンス:
{ "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 }参照
ソース
CGraphItem::get() in ui/include/classes/api/services/CGraphItem.php.