graphprototype.update

Description

object graphprototype.update(object/array graphPrototypes)

Cette méthode permet de mettre à jour des prototypes de graphiques existants.

Cette méthode est disponible uniquement pour les types d'utilisateurs Admin et Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôles utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(object/array) Propriétés du prototype de graphique à mettre à jour.

La propriété graphid doit être définie pour chaque prototype de graphique, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

En plus des propriétés de l'objet prototype de graphique standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
gitems array Éléments de graphique en remplacement des éléments de graphique existants. Si un élément de graphique a la propriété gitemid définie, il sera mis à jour, sinon un nouvel élément de graphique sera créé.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des prototypes de graphique mis à jour sous la propriété graphids.

Exemples

Modification de la taille d'un prototype de graphique

Modifiez la taille d'un prototype de graphique entre 1 100 et 400 pixels.

Requête :

{
           "jsonrpc": "2.0",
           "method": "graphprototype.update",
           "params": {
               "graphid": "439",
               "width": 1100,
               "height": 400
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

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

Source

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