graphprototype.update

説明

object graphprototype.update(object/array graphPrototypes)

このメソッドは、既存のグラフプロトタイプを更新するためのものです。

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

パラメータ

(object/array) 更新するグラフプロトタイプのプロパティ。

各グラフプロトタイプには graphid プロパティを定義する必要があり、他のプロパティはオプションです。渡されたプロパティのみが更新され、他のプロパティは変更されません。

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

パラメータ 型 説明
gitems array 既存のグラフアイテムを置き換えるグラフアイテム。グラフアイテムに gitemid プロパティが定義されている場合は更新され、定義されていない場合は新しいグラフアイテムが作成されます。

戻り値

(object) graphids プロパティの下で更新された graph prototypes の ID を含むオブジェクトを返します。

例

グラフプロトタイプのサイズ変更

グラフプロトタイプのサイズを1100×400ピクセルに変更します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "graphprototype.update",
    "params": {
        "graphid": "439",
        "width": 1100,
        "height": 400
    },
    "id": 1
}

レスポンス:

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

ソース

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