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'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir les rôles utilisateur pour plus d'informations.

Paramètres

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

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

Paramètre	Type	Description
pages (obligatoire)	array	Pages à créer pour le tableau de bord. Les pages du tableau de bord seront classées dans le même ordre que celui spécifié. Au moins un objet de page de tableau de bord est requis pour la propriété `pages`.
users	array	Partages utilisateurs du tableau de bord à créer pour le tableau de bord.
userGroups	array	Partages groupes d'utilisateurs du tableau de bord à créer pour 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é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) sur une page de tableau de bord seule.

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": 12,
        "height": 5,
        "view_mode": 0,
        "fields": [
        {
        "type": 1,
        "name": "tags.tag.0",
        "value": "service"
        },
        {
        "type": 0,
        "name": "tags.operator.0",
        "value": 1
        },
        {
        "type": 1,
        "name": "tags.value.0",
        "value": "zabbix_server"
        }
        ]
        }
        ]
        }
        ],
        "userGroups": [
        {
        "usrgrpid": "7",
        "permission": 2
        }
        ],
        "users": [
        {
        "userid": "4",
        "permission": 3
        }
        ]
        },
        "auth": "038e1d7b1735c6a5436ee9eae095879e",
        "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.

Documentation