graphitem.get

Description

integer/array graphitem.get(object parameters)

La méthode permet de récupérer des éléments de graphique selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
graphids ID/array Retourner uniquement les éléments de graphique qui appartiennent aux graphiques donnés.
itemids ID/array Retourner uniquement les éléments de graphique avec les ID d'élément donnés.
type integer Retourner uniquement les éléments de graphique du type donné.

Consultez la page de l'objet d'élément de graphique pour obtenir la liste des types d'éléments de graphique pris en charge.
selectGraphs query Retourner une propriété graphs avec un tableau des graphiques auxquels l'élément appartient.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : gitemid.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
limit integer
output query
preservekeys boolean
sortorder string/array

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des éléments de graphique à partir d’un graphique

Récupérez tous les éléments de graphique utilisés dans un graphique avec des informations supplémentaires sur l’élément et l’hôte.

Requête:

{
    "jsonrpc": "2.0",
    "method": "graphitem.get",
    "params": {
        "output": "extend",
        "graphids": "387"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "gitemid": "1242",
            "graphid": "387",
            "itemid": "22665",
            "drawtype": "1",
            "sortorder": "1",
            "color": "FF5555",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0"
        },
        {
            "gitemid": "1243",
            "graphid": "387",
            "itemid": "22668",
            "drawtype": "1",
            "sortorder": "2",
            "color": "55FF55",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0"
        },
        {
            "gitemid": "1244",
            "graphid": "387",
            "itemid": "22671",
            "drawtype": "1",
            "sortorder": "3",
            "color": "009999",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0"
        }
    ],
    "id": 1
}

Voir également

Source

CGraphItem::get() dans ui/include/classes/api/services/CGraphItem.php.