dashboard.get

Description

integer/array dashboard.get(object parameters)

La méthode permet de récupérer des tableaux de bord en fonction des paramètres donnés.

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
dashboardids chaîne/tableau Renvoie uniquement les tableaux de bord avec les identifiants donnés.
selectWidgets requête Renvoie les widgets de tableau de bord utilisés dans le tableau de bord avec la propriété widgets.
selectUsers requête Renvoie les utilisateurs avec lesquels le tableau de bord est partagé dans la propriété users.
selectUserGroups requête Renvoie les groupes d'utilisateurs avec lesquels le tableau de bord est partagé dans la propriété userGroups.
sortfield chaîne/tableau Trie le résultat en fonction des propriétés données.

La valeur possible est : dashboardid.
countOutput booléen Ces paramètres communs à toutes les méthodes get sont décrits en détail dans la page de commentaire de référence.
editable booléen
excludeSearch booléen
filter object
limit entier
output requête
preservekeys booléen
search object
searchByAny booléen
searchWildcardsEnabled booléen
sortorder chaîne/tableau
startSearch booléen

Valeurs de retour

(entier/tableau) 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 d'un tableau de bord par ID

Récupérer toutes les données sur les tableaux de bord "1" et "2".

Requête :

{
    "jsonrpc": "2.0",
    "method": "dashboard.get",
    "params": {
        "output": "extend",
        "selectWidgets": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "dashboardids": [
            "1",
            "2"
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "dashboardid": "1",
            "name": "Dashboard",
            "userid": "1",
            "private": "0",
            "users": [],
            "userGroups": [],
            "widgets": [
                {
                    "widgetid": "9",
                    "type": "systeminfo",
                    "name": "",
                    "x": "6",
                    "y": "8",
                    "width": "6",
                    "height": "5",
                    "fields": []
                },
                {
                    "widgetid": "8",
                    "type": "problemsbysv",
                    "name": "",
                    "x": "6",
                    "y": "4",
                    "width": "6",
                    "height": "4",
                    "fields": []
                },
                {
                    "widgetid": "7",
                    "type": "problemhosts",
                    "name": "",
                    "x": "6",
                    "y": "0",
                    "width": "6",
                    "height": "4",
                    "fields": []
                },
                {
                    "widgetid": "6",
                    "type": "discovery",
                    "name": "",
                    "x": "3",
                    "y": "9",
                    "width": "3",
                    "height": "4",
                    "fields": []
                },
                {
                    "widgetid": "5",
                    "type": "web",
                    "name": "",
                    "x": "0",
                    "y": "9",
                    "width": "3",
                    "height": "4",
                    "fields": []
                },
                {
                    "widgetid": "4",
                    "type": "problems",
                    "name": "",
                    "x": "0",
                    "y": "3",
                    "width": "6",
                    "height": "6",
                    "fields": []
                },
                {
                    "widgetid": "3",
                    "type": "favmaps",
                    "name": "",
                    "x": "4",
                    "y": "0",
                    "width": "2",
                    "height": "3",
                    "fields": []
                },
                {
                    "widgetid": "2",
                    "type": "favscreens",
                    "name": "",
                    "x": "2",
                    "y": "0",
                    "width": "2",
                    "height": "3",
                    "fields": []
                },
                {
                    "widgetid": "1",
                    "type": "favgraphs",
                    "name": "",
                    "x": "0",
                    "y": "0",
                    "width": "2",
                    "height": "3",
                    "fields": []
                }
            ]
        },
        {
            "dashboardid": "2",
            "name": "My dashboard",
            "userid": "1",
            "private": "1",
            "users": [
                {
                    "userid": "4",
                    "permission": "3"
                }
            ],
            "userGroups": [
                {
                    "usrgrpid": "7",
                    "permission": "2"
                }
            ],
            "widgets": [
                {
                    "widgetid": "10",
                    "type": "problems",
                    "name": "",
                    "x": "0",
                    "y": "0",
                    "width": "6",
                    "height": "5",
                    "fields": [
                        {
                            "type": "2",
                            "name": "groupids",
                            "value": "4"
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}

Voir aussi

Source

CDashboard::get() dans frontends/php/include/classes/api/services/CDashboard.php.