dashboard.create

Descripción

object dashboard.create(object/array dashboards)

Este método permite crear nuevos paneles.

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

Parámetros

(object/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:
- obligatorio
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

(object) Devuelve un objeto que contiene los IDs de los paneles creados bajo la propiedad dashboardids. El orden de los IDs devueltos coincide con el orden de los paneles enviados.

Ejemplos

Creando un panel

Cree un panel llamado "Mi panel" con un widget de Problemas con etiquetas y utilizando dos tipos de compartición (grupo de usuarios y usuario) en una sola página de panel.

Solicitud:

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

Respuesta:

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

Ver también

Fuente

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