graph.update

説明

object graph.update(object/array graphs)

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

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

パラメータ

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

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

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

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

戻り値

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

例

Y軸スケールの最大値の設定

Y軸スケールの最大値を固定値100に設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "graph.update",
    "params": {
        "graphid": "439",
        "ymax_type": 1,
        "yaxismax": 100
    },
    "id": 1
}

レスポンス:

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

ソース

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