graph.create

説明

object graph.create(object/array graphs)

このメソッドは、新しいグラフを作成することができます。

このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

(object/array) 作成するグラフ。

graphの標準プロパティに加えて、このメソッドは以下のパラメーターを受け付けます。

パラメーター タイプ 説明
gitems array グラフ用に作成するグラフアイテム。

パラメーターの動作:
- 必須

戻り値

(object) graphidsプロパティの下に作成されたグラフのIDを含むオブジェクトを返します。返されるIDの順序は、渡されたグラフの順序と一致します。

例

グラフの作成

2つのアイテムからなるグラフを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "graph.create",
    "params": {
        "name": "MySQL bandwidth",
        "width": 900,
        "height": 200,
        "gitems": [
            {
                "itemid": "22828",
                "color": "00AA00"
            },
            {
                "itemid": "22829",
                "color": "3333FF"
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "graphids": [
            "652"
        ]
    },
    "id": 1
}

参照

ソース

CGraph::create() in ui/include/classes/api/services/CGraph.php.