templatedashboard.create

Description

object templatedashboard.create(object/array templateDashboards)

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

Cette méthode est disponible uniquement pour les types d’utilisateurs Admin et Super admin. 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/array) Tableaux de bord de modèle à créer.

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

Paramètre Type Description
pages array Pages de tableau de bord de modèle à 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

Valeurs retournées

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

Exemples

Création d’un tableau de bord de modèle

Créez un tableau de bord de modèle nommé « Graphs » avec un widget Graph sur une seule page de tableau de bord.

Requête :

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.create",
    "params": {
        "templateid": "10318",
        "name": "Graphs",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graph",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 6,
                                "name": "graphid",
                                "value": "1123"
                            }
                        ]
                    }
                ]

            }
        ]
    },
    "id": 1
}

Réponse :

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

Voir également

Source

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