graphprototype.create

説明

object graphprototype.create(object/array graphPrototypes)

このメソッドは新しいグラフプロトタイプを作成するためのものです。

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

パラメーター

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

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

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

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

戻り値

(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.