Objeto dashboard

Los siguientes objetos están directamente relacionados con la API de dashboard.

Dashboard

El objeto dashboard tiene las siguientes propiedades.

Propiedad Tipo Descripción
dashboardid ID ID del dashboard.

Comportamiento de la propiedad:
- solo lectura
- requerido para operaciones de actualización
name string Nombre del dashboard.

Comportamiento de la propiedad:
- requerido para operaciones de creación
userid ID ID del usuario que es propietario del dashboard.
private integer Tipo de compartición del dashboard.

Valores posibles:
0 - dashboard público;
1 - (por defecto) dashboard privado.
display_period integer Período de visualización por defecto de la página (en segundos).

Valores posibles: 10, 30, 60, 120, 600, 1800, 3600.

Por defecto: 30.
auto_start integer Inicio automático de la presentación de diapositivas.

Valores posibles:
0 - no iniciar automáticamente la presentación de diapositivas;
1 - (por defecto) iniciar automáticamente la presentación de diapositivas.

Página del dashboard

El objeto de la página del dashboard tiene las siguientes propiedades.

Propiedad Tipo Descripción
dashboard_pageid ID ID de la página del dashboard.

Comportamiento de la propiedad:
- solo lectura
name string Nombre de la página del dashboard.

Por defecto: cadena vacía.
display_period integer Periodo de visualización de la página del dashboard (en segundos).

Valores posibles: 0, 10, 30, 60, 120, 600, 1800, 3600.

Por defecto: 0 (usará el periodo de visualización de página por defecto).
widgets array Array de objetos widget del dashboard.

Widget de dashboard

El objeto widget de dashboard tiene las siguientes propiedades.

Propiedad Tipo Descripción
widgetid ID ID del widget de dashboard.

Comportamiento de la propiedad:
- solo lectura
type string Tipo de widget de dashboard.

Valores posibles:
actionlog - Registro de acciones;
clock - Reloj;
discovery - Estado del descubrimiento;
favgraphs - Gráficas favoritas;
favmaps - Mapas favoritos;
gauge - Medidor;
geomap - Geomapa;
graph - Gráfica (clásica);
graphprototype - Prototipo de gráfica;
honeycomb - Panal;
hostavail - Disponibilidad de host;
hostcard - Tarjeta de host;
hostnavigator - Navegador de host;
itemcard - Tarjeta de item;
itemhistory - Historial de item;
itemnavigator - Navegador de item;
item - Valor de item;
map - Mapa;
navtree - Árbol de navegación de mapas;
piechart - Gráfica circular;
problemhosts - Hosts con problemas;
problems - Problemas;
problemsbysv - Problemas por severidad;
scatterplot - Diagrama de dispersión;
slareport - Informe de SLA;
svggraph - Gráfica;
systeminfo - Información del sistema;
tophosts - Hosts principales;
topitems - Items principales;
toptriggers - Triggers principales;
trigover - Resumen de triggers;
url - URL;
web - Monitorización web.

Comportamiento de la propiedad:
- requerido
name string Nombre personalizado del widget.
x integer Posición horizontal desde el lado izquierdo del dashboard.

Los valores posibles van de 0 a 71.
y integer Posición vertical desde la parte superior del dashboard.

Los valores posibles van de 0 a 63.
width integer El ancho del widget.

Los valores posibles van de 1 a 72.
height integer La altura del widget.

Los valores posibles van de 1 a 64.
view_mode integer El modo de visualización del widget.

Valores posibles:
0 - (por defecto) vista por defecto del widget;
1 - con cabecera oculta;
fields array Array de objetos campo de widget de dashboard.

Comportamiento de la propiedad:
- ver widgets individuales en Campos de widget de dashboard
Campo de widget de dashboard

El objeto campo de widget de dashboard tiene las siguientes propiedades.

Propiedad Tipo Descripción
type integer Tipo de campo de widget.

Valores posibles:
0 - Integer;
1 - String;
2 - Grupo de hosts;
3 - Host;
4 - Item;
5 - Prototipo de item;
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 string Nombre del campo de widget.

Valores posibles: ver Campos de widget de dashboard.

Comportamiento de la propiedad:
- requerido
value mixed Valor del campo de widget dependiendo del tipo.

Valores posibles: ver Campos de widget de dashboard.

Comportamiento de la propiedad:
- requerido

Grupo de usuarios del dashboard

Lista de permisos del dashboard basados en grupos de usuarios. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
usrgrpid ID ID del grupo de usuarios.

Comportamiento de la propiedad:
- requerido
permission integer Tipo de nivel de permiso.

Valores posibles:
2 - solo lectura;
3 - lectura-escritura.

Comportamiento de la propiedad:
- requerido

Usuario del dashboard

Lista de permisos del dashboard basados en usuarios. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
userid ID ID del usuario.

Comportamiento de la propiedad:
- requerido
permission integer Tipo de nivel de permiso.

Valores posibles:
2 - solo lectura;
3 - lectura-escritura.

Comportamiento de la propiedad:
- requerido