graphprototype.update

説明

object graphprototype.update(object/array graphPrototypes)

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

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

パラメータ

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

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

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

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

戻り値

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

例

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

グラフプロトタイプのサイズを1100 x 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.