grafiek.update

Beschrijving

object graph.update(object/array graphs)

Deze methode maakt het mogelijk om bestaande grafieken bij te werken.

Deze methode is alleen beschikbaar voor gebruikers met het type Admin en Super admin. Rechten om de methode op te roepen kunnen worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Grafiekeigenschappen moeten worden bijgewerkt.

De eigenschap graphid moet voor elke grafiek worden gedefinieerd, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, allemaal andere blijven ongewijzigd.

Naast de standaard grafiekeigenschappen de methode accepteert de volgende parameters.

Parameter Type Beschrijving
gitems array Graph items om bestaande grafiekitems te vervangen. Als een grafiekitem de eigenschap `gitemid' heeft gedefinieerd, wordt het bijgewerkt, anders wordt er een nieuw grafiekitem gemaakt.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte grafieken bevat onder de eigenschap graphids.

Voorbeelden

Instellen van het maximum voor de Y-schaal

Stel het maximum van de Y-schaal in op een vaste waarde van 100.

Verzoek:

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

Reactie:

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

Bron

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