dashboard.create

Description

object dashboard.create(object/array dashboards)

Cette méthode permet de créer de nouveaux tableaux de bord.

Paramètres

(object/array) Tableau de bord à créer.

Outre les propriétés standards de tableau de bord, la méthode accepte les paramètres suivants.

Paramètre Type Description
widgets tableau Widget à créer pour le tableau de bord.
users tableau Les partages utilisateur à créer sur le tableau de bord.
userGroups tableau Les partages des groupes d'utilisateurs à créer pour le tableau de bord.

Valeur de retour

(object) Retourne un objet contenant les IDs du tableau de bord créé dans les propriétés dashboardids. L'ordre des ID retournés correspond à l'ordre des tableaux de bord transmis.

Exemples

Création d'un tableau de bord

Créer un tableau de bord nommé "My dashboard" avec un widget Problèmes avec des tags et utilisant deux type de partages (utilisateur et groupe d'utilisateurs).

Requête :

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "widgets": [
            {
                "type": "problems",
                "x": 0,
                "y": 0,
                "width": 6,
                "height": 5,
                "fields": [
                    {
                        "type": 1,
                        "name": "tags.tag.0",
                        "value": "service"
                    },
                    {
                        "type": 1,
                        "name": "tags.value.0",
                        "value": "zabbix_server"
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": "2"
            }
        ],
        "users": [
            {
                "userid": "4",
                "permission": "3"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "2"
        ]
    },
    "id": 1
}

Voir aussi

Source

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