Documentation
Table of Contents
Objecte de tauler
Els objectes següents tenen relació directa amb l'API dashboard.
Tauler
L'objecte tauler té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| dashboardid | ID | (només lectura) ID del tauler. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| name | string | Nom del tauler. |
| userid | ID | ID de l'usuari propietari del tauler. |
| private | integer | Tipus de compartició del tauler. Valors possibles: 0 - tauler públic; 1 - (per defecte) tauler privat. |
| display_period | integer | Període (en segons) de mstra de la pàgina per defecte. Valors possibles: 10, 30, 60, 120, 600, 1800, 3600. Per defecte: 30. |
| auto_start | integer | Iniciar presentació automàticament. Valors possibles: 0 - no iniciar-la automàticament; 1 - (per defecte) iniciar-la automàticament. |
Pàgina de tauler
L'objecte de pàgina de tauler té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| dashboard_pageid | ID | ID de la pàgina del tauler.. Comportament de la propietat: - només lectura |
| name | string | Nom de la pàgina del tauler. Per defecte: cadena buida. |
| display_period | integer | Temps de mostra de la pàgina del tauler (en segons). Valors possibles: 0, 10, 30, 60, 120, 600, 1800, 3600. Per defecte: 0 (empra el període de mostra de pàgina per defecte). |
| widgets | array | Matriu dels objectes ginys de tauler. |
Giny de tauler
L'objecte giny de tauler té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| widgetid | ID | ID del giny de tauler. Comportament de la propietat: - només lectura |
| tipus | string | Tipus de giny de tauler. Valors possibles: actionlog - Registre d'acció; clock - Rellotge; (obsolet) dataover - Vista general d'informació; discovery - Estat de descoberta; favgraphs - Gràfics preferits; favmaps - Mapes preferits; gauge - Calibre; geomap - Geomapa; graph - Gràfic (clàssic); graphprototype - Prototipus de gràfic; honeycomb - Rusc; hostavail - Disponibilitat de l'equip; hostnavigator - Navegador d'equips; itemhistory - Historial de l'element; itemnavigator - Navegador d'elements; item - Valor d'element; map - Mapa; navtree - Arbre de navegació del mapa; piechart - Gràfic de pastís; problemhosts - Equips amb problemes; problems - Problemes; problemsbysv - Problemes per gravetat; slareport - Informe d'SLA; svggraph - Gràfic; systeminfo - Informació del sistema; tophosts - Equips principals; toptriggers - Triggers principals; trigover - Vista general dels triggers; url - URL; web - Monitoratge Web. Comportament de la propietat: - obligatori |
| name | string | Nom del giny personalitzat. |
| x | integer | Posició horitzontal des de l'esquerra del tauler. Interval vàlid des de 0 a 23. |
| y | integer | Posició vertical des de dalt del tauler. Valors vàlids entre 0 i 62. |
| width | integer | Amplada del giny. Valors vàlids entre 1 i 24. |
| height | integer | Alçada del giny. Valors vàlids entre 2 i 32. |
| view_mode | integer | Mode de vista del giny. Valors possibles: 0 - (per defecte) vista del giny per defecte; 1 - amb capçalera oculta; |
| fields | array | Taula dels objectes camp del giny del tauler. Comportament de la propietat: - veieu els ginys individuals al Tauler de camps de giny |
Camp del giny de tauler
L'objecte de camp de giny del tauler té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| tipus | integer | Tipus de camp de giny. Valors possibles: 0 - Enter; 1 - Cadena; 2 - Grup d'equips; 3 - Equip; 4 - Element; 5 - Prototipus d'elements; 6 - Gràfic; 7 - Prototipus de gràfics; 8 - Mapa; 9 - Servei; 10 - SLA; 11 - Uusari; 12 - Acció; 13 - Tipus de suport. Comportament de la propietat: - obligatori |
| name | string | Nom del camp de giny. Valors possibles: veieu Camps de giny de tauler. Comportament de la propietat: - obligatori |
| value | mixed | Valor del camp de giny depenent segons el tipus. Valors possibles: veieu Camps de giny de tauler. Comportament de la propietat: - obligatori |
Grup d'usuaris del tauler
Llistat dels permisos del tauler en funció dels grups d'usuaris. L'objecte té les següents propietats:
| Propietat | Tipus | Descripció |
|---|---|---|
| usrgrpid | ID | ID del grup d'usuaris. Comportament de la propietat: - obligatori |
| permission | integer | Tipus del nivell de permisos. Valors possibles: 2 - només lectura; 3 - lectura i escriptura. Comportament de la propietat: - obligatori |
Usuaris del tauler
Llistat dels permisos del tauler en funció dels usuaris. L'objecte té les següents propietats:
| Propietat | Tipus | Descripció |
|---|---|---|
| userid | ID | ID de l'usuari. Comportament de la propietat: - obligatori |
| permission | integer | Tipus del nivell de permisos. Valors possibles: 2 - només lectura; 3 - lectura i escriptura. Comportament de la propietat: - obligatori |