dashboard.create

Descripción

object dashboard.create(object/array dashboards)

Este método permite crear nuevos tableros.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.

Parámetros

(objeto/array) Dashboards a crear.

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

Parámetro Tipo Descripción
pages array Páginas del dashboard 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:
- requerido
users array Usuarios del dashboard que se compartirán en el dashboard.
userGroups array Grupos de usuarios del dashboard que se compartirán en el dashboard.

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de los tableros creados bajo la propiedad dashboardids. El orden de los ID devueltos coinciden con el orden de los tableros pasados.

Ejemplos

Creando un tablero

Cree un tablero llamado "Mi tablero" con un widget de Problemas con etiquetas y usando dos tipos de uso compartido (grupo de usuarios y usuario) en una sola página del tablero.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "Mi tablero",
        "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
}

Respuesta:

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

Ver también

Fuente

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