graph.update

説明

object graph.update(object/array graphs)

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

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

パラメータ

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

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

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

パラメータ 型 説明
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.