dashboard.create

Description

object dashboard.create(object/array dashboards)

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

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appeler 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/array) Tableaux de bord à créer.

En plus des propriétés standard des tableaux de bord, la méthode accepte les paramètres suivants.

Paramètre Type Description
pages array Pages du tableau de bord à créer pour le tableau de bord. Les pages du tableau de bord seront ordonnées dans le même ordre que celui spécifié.

Comportement du paramètre :
- obligatoire
users array Partages d’utilisateur de tableau de bord à créer sur le tableau de bord.
userGroups array Partages de groupe d’utilisateurs de tableau de bord à créer sur le tableau de bord.

Valeurs retournées

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

Exemples

Création d’un tableau de bord

Créez un tableau de bord nommé "My dashboard" avec un widget Problems comportant des tags et en utilisant deux types de partage (groupe d’utilisateurs et utilisateur) sur une seule page de tableau de bord.

Requête:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "problems",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "service"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "zabbix_server"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Réponse :

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

Voir également

Source

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