graphprototype.create

Beschrijving

object graphprototype.create(object/array graphPrototypes)

Deze methode maakt het mogelijk om nieuwe grafiek-prototypen aan te maken.

Deze methode is alleen beschikbaar voor gebruikerstypen Admin en Superadmin. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Grafiek-prototypen om aan te maken.

Naast de standaard eigenschappen van grafiek-prototype, accepteert de methode de volgende parameters.

Parameter	Type	Beschrijving
gitems	array	Grafiek items die moeten worden aangemaakt voor de grafiek-prototypen. Grafiek-items kunnen zowel verwijzen naar items als item-prototypen, maar er moet minstens één item-prototype aanwezig zijn. Gedrag van de parameter: - verplicht

Retourwaarden

(object) Retourneert een object dat de ID's van de gemaakte grafiek bevat prototypes onder de eigenschap graphids. De volgorde van de geretourneerde ID's komt overeen met de volgorde van de doorgegeven grafiekprototypes.

Voorbeelden

Grafiek-prototype aanmaken

Maak een grafiek-prototype aan met twee items.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "graphprototype.create",
           "params": {
               "name": "Schijfruimtegebruik {#FSNAME}",
               "width": 900,
               "height": 200,
               "gitems": [
                   {
                       "itemid": "22828",
                       "color": "00AA00"
                   },
                   {
                       "itemid": "22829",
                       "color": "3333FF"
                   }
               ]
           },
           "id": 1
       }

Reactie:

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

Zie ook

Grafiekitem

Bron

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

Documentation