graph.create

説明

object graph.create(object/array graphs)

この方法で、新しいグラフを作成することができます。

このメソッドは、Admin および Super admin ユーザータイプにのみ使用できます。このメソッドを呼び出す許可は、
ユーザーロール設定で取り消すことができます。詳細については、User rolesを参照してください。

パラメータ

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

standard graph propertiesに加えて、このメソッドは以下のパラメータを受け付ける。

パラメータ Type 説明
gitems
(required)
array Graph items to be created for the graph.

戻り値

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

グラフの作成

2つの項目からなるグラフを作成します。

Request:

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

Response:

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

参照

ソース

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