graphprototype.update

Description

object graphprototype.update(object/array graphPrototypes)

This method allows to update existing graph prototypes.

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 prototype properties to be updated.

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

Additionally to the standard graph prototype 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 graph prototypes under the graphids property.

Examples

Changing the size of a graph prototype

Change the size of a graph prototype to 1100 to 400 pixels.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "graphprototype.update",
  4.            "params": {
  5.                "graphid": "439",
  6.                "width": 1100,
  7.                "height": 400
  8.            },
  9.            "id": 1
  10.        }

Response:

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

Source

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