graphprototype.create

説明

object graphprototype.create(object/array graphPrototypes)

このメソッドでは、新しいグラフプロトタイプを作成できます。

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

パラメータ

(object/array) 作成するグラフプロトタイプ。

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

パラメータ Type 説明
gitems array グラフプロトタイプ用に作成されるグラフアイテム。グラフアイテムはアイテムとアイテムプロトタイプの両方を参照できますが、少なくとも1つのアイテムプロトタイプが含まれている必要があります。

Parameter behavior:
- required

戻り値

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

例

グラフプロトタイプの作成

2つのアイテムを持つグラフプロトタイプを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "graphprototype.create",
    "params": {
        "name": "Disk space usage {#FSNAME}",
        "width": 900,
        "height": 200,
        "gitems": [
            {
                "itemid": "22828",
                "color": "00AA00"
            },
            {
                "itemid": "22829",
                "color": "3333FF"
            }
        ]
    },
    "id": 1
}

レスポンス:

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

関連項目

ソース

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