graph.update

Description

object graph.update(object/array graphs)

This method allows to update existing graphs.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Graph properties to be updated.

The graphid property must be defined for each graph, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard graph properties the method accepts the following parameters.

ParameterTypeDescription
gitemsarrayGraph items to replace existing graph items. If a graph item has the gitemid property defined it will be updated, otherwise a new graph item will be created.

Return values

(object) Returns an object containing the IDs of the updated graphs under the graphids property.

Examples

Setting the maximum for the Y scale

Set the the maximum of the Y scale to a fixed value of 100.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "graph.update",
  4.            "params": {
  5.                "graphid": "439",
  6.                "ymax_type": 1,
  7.                "yaxismax": 100
  8.            },
  9.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10.            "id": 1
  11.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "graphids": [
  5.                    "439"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

Source

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