templatedashboard.create

Descripción

object templatedashboard.create(object/array templateDashboards)

Este método permite crear nuevas plantillas de tablero.

Este método solo está disponible para los tipos de usuario Administrador y Superadministrador. Los permisos para llamar al método se pueden revocar en la configuración del rol de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto/array) Dashboards de template a crear.

Además de las propiedades estándar del dashboard de template, el método acepta los siguientes parámetros.

Parámetro Tipo Descripción
pages array Páginas del dashboard de template que se crearán para el dashboard. Las páginas del dashboard se ordenarán en el mismo orden que se especifique.

Comportamiento del parámetro:
- obligatorio

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de las plantillas de tablero creadas bajo la propiedad dashboardids. El orden de los ID devueltos coinciden con el orden de las plantillas de tablero pasadas.

Ejemplos

Creando un dashboard de template

Cree un dashboard de template llamado "Graphs" con un widget de Graph en una sola página de dashboard.

Request:

{
    "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
}

Respuesta:

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

Ver también

Fuente

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