Documentation
Table of Contents
> Objeto del tablero
Los siguientes objetos están directamente relacionados con la API dashboard.
Tablero
El objeto del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| dashboardid | cadena | ID del tablero. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| name | cadena | Nombre del tablero. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| userid | cadena | ID de usuario del propietario del tablero. |
| private | entero | Tipo de panel compartido. Valores posibles: 0 - tablero público; 1 - (predeterminado) tablero privado. |
| display_period | entero | Período de visualización de página predeterminado (en segundos). Valores posibles: 10, 30, 60, 120, 600, 1800, 3600. Predeterminado: 30. |
| auto_start | entero | Iniciar presentación de diapositivas automáticamente. Valores posibles: 0 - no iniciar presentación de diapositivas automáticamente; 1 - (predeterminado) iniciar presentación de diapositivas automáticamente. |
Página del tablero
El objeto de la página del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| dashboard_pageid | cadena | ID de la página del tablero. Comportamiento de la propiedad: - solo lectura |
| name | cadena | Nombre de la página del panel. Predeterminado: cadena vacía. |
| display_period | entero | Período de visualización de la página del panel (en segundos). Valores posibles: 0, 10, 30, 60, 120, 600, 1800, 3600. Predeterminado: 0 (Utilizará el período de visualización de página predeterminado). |
| widgets | matriz | Matriz de los objetos widget del tablero. |
Widget del tablero
El objeto del widget del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| widgetid | cadena | ID del widget del tablero. Comportamiento de la propiedad: - solo lectura |
| type | cadena | Tipo del widget del tablero. Valores posibles: actionlog - Registro de acciones; clock - Reloj; (obsoleto) dataover - Visión general de datos;<br >discovery - Estado del descubrimiento; favgraphs - Gráficos favoritos; favmaps - Mapas favoritos; graph - Gráfico (clásico); graphprototype - Prototipo de gráfico; hostavail - Disponibilidad del equipo;<br >item - Valor de la métrica; map - Mapa; navtree - Árbol de navegación del mapa; plaintext - Texto sin formato; problemhosts - Equipos con problemas; problems - Problemas; problemsbysv - Problemas por gravedad; slareport - Informe SLA; svggraph - Gráfico; systeminfo - Información del sistema; tophosts - Principales equipos; trigover - Descripción general del iniciador; url - URL; web - Monitoreo web. Comportamiento de la propiedad: - obligatorio |
| name | cadena | Nombre del widget personalizado. |
| x | entero | Una posición horizontal desde el lado izquierdo del tablero. Los valores válidos van de 0 a 23. |
| y | entero | Una posición vertical desde la parte superior del tablero. Los valores válidos van de 0 a 62. |
| width | integer | El ancho del widget. Los valores válidos oscilan entre 1 y 24. |
| height | integer | La altura del widget. Los valores válidos oscilan entre 2 y 32. |
| view_mode | integer | El modo de vista del widget. Valores posibles: 0 - (predeterminado) vista predeterminada del widget; 1 - con encabezado oculto; |
| fields | matriz | Matriz de los objetos campo del widget del tablero. Comportamiento de la propiedad: - ver widgets individuales en campos de widget de tablero |
Campo del widget del tablero
El objeto de campo del widget del tablero tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | entero | Tipo del campo del widget. Valores posibles: 0 - Entero; 1 - Cadena; 2 - Grupo de equipos; 3 - Equipo;< br>4 - Métrica; 5 - Prototipo de métrica; 6 - Gráfico; 7 - Prototipo de gráfico; 8 - Mapa; 9 - Servicio; 10 - SLA; 11 - Usuario; 12 - Acción; 13 - Tipo de medio. Comportamiento de la propiedad: - * requerido* |
| name | cadena | Nombre del campo del widget. Valores posibles: consulte Campos del widget del panel. Comportamiento de la propiedad: - obligatorio |
| value | mixto | Valor del campo del widget según el tipo. Valores posibles: consulte Campos del widget del panel. Comportamiento de la propiedad: - obligatorio |
Grupo de usuarios del tablero
Lista de permisos del tablero basados en grupos de usuarios. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| usrgrpid | string | ID de grupo de usuarios. Comportamiento de la propiedad: - obligatorio |
| permission | entero | Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura. Comportamiento de la propiedad: - obligatorio |
Usuario del tablero
Lista de permisos del tablero basados en usuarios. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| userid | cadena | ID de usuario. Comportamiento de la propiedad: - obligatorio |
| permission | entero | Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura. Comportamiento de la propiedad: - obligatorio |