Table of Contents
> Objeto do painel
Os objetos a seguir estão diretamente relacionados à API dashboard.
Painel
O objeto de painel tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| dashboardid | string | (readonly) ID do painel. |
| name (obrigatório) |
string | Nome do painel. |
| userid | string | ID do usuário do proprietário do painel. |
| private | inteiro | Tipo de compartilhamento do painel. Valores possíveis: 0 - painel público; 1 - (padrão) painel privado. |
| display_period | inteiro | Período de exibição da página padrão (em segundos). Valores possíveis: 10, 30, 60, 120, 600, 1800, 3600. Padrão: 30. |
| auto_start | integer | Iniciar apresentação de slides automaticamente. Valores possíveis: 0 - não iniciar apresentação de slides automaticamente; 1 - (padrão) iniciar apresentação de slides automaticamente. |
Observe que para alguns métodos (update, delete) a combinação de parâmetros obrigatórios/opcionais é diferente.
Página do painel
O objeto de página do painel tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| dashboard_pageid | string | (readonly) ID da página do painel. |
| name | string | Nome da página do painel. Padrão: string vazia. |
| display_period | inteiro | Período de exibição da página do painel (em segundos). Valores possíveis: 0, 10, 30, 60, 120, 600, 1800, 3600. Padrão: 0 (usará o período de exibição de página padrão). |
| widgets | array | Array dos objetos widget do painel. |
Widget do painel
O objeto widget do painel tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| widgetid | string | (readonly) ID do widget do painel. |
| type (obrigatório) |
string | Tipo do widget do painel. Valores possíveis: actionlog - Log de ações; clock - Relógio; (preterido) dataover - Visão geral dos dados; discovery - Status da descoberta; favgraphs - Gráficos favoritos; favmaps - Mapas favoritos; graph - Gráfico (clássico); graphprototype - Protótipo do gráfico; hostavail - Disponibilidade do host; item - Valor do item; map - Mapa; navtree - Árvore de navegação do mapa; plaintext - Texto puro; problemhosts - Hosts com problema; problems - Problemas; problemsbysv - Problemas por gravidade; slareport - Relatório SLA; svggraph - Gráfico; systeminfo - Informações do sistema; tophosts - Principais hosts; trigover - Visão geral do acionador; url - URL; web - Monitoramento da web. |
| name | string | Nome do widget personalizado. |
| x | inteiro | Uma posição horizontal do lado esquerdo do painel. Os valores válidos variam de 0 a 23. |
| y | inteiro | Uma posição vertical da parte superior do painel. Os valores válidos variam de 0 a 62. |
| width | integer | A largura do widget. Os valores válidos variam de 1 a 24. |
| altura | inteiro | A altura do widget. Os valores válidos variam de 2 a 32. |
| view_mode | integer | O modo de visualização de widget. Valores possíveis: 0 - (padrão) visualização de widget padrão; 1 - com cabeçalho oculto; |
| fields | array | Array dos objetos campo do widget do painel. Obrigatório para widgets específicos; veja widgets individuais em Campos de widget do painel. |
Objeto de campo do widget de painel
O objeto de campo do widget de painel possui as seguintes propriedades.
| Propriedade | Type | Descrição |
|---|---|---|
| type (obrigatório) |
inteiro | Tipo do campo de widget. Valores possíveis: 0 - Inteiro; 1 - String; 2 - Grupo de hosts; 3 - Host; 4 - Item; 5 - Protótipo item; 6 - Gráfico; 7 - Protótipo gráfico; 8 - Mapa; 9 - Serviço; 10 - SLA. |
| name (obrigatório) |
string | Nome do campo do widget. Valores possíveis: consulte manual Dashboard widget fields. |
| value (obrigatório) |
variado | Valor do campo do widget dependendo do tipo. Valores possíveis: consulte manual Dashboard widget fields. |
Grupo de usuários do Dashboard
Lista de permissões do painel com base em grupos de usuários. Tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| usrgrpid (required) |
string | ID do grupo de usuários. |
| permission (required) |
integer | Tipo de nível de permissão. Valores possíveis: 2 - somente leitura; 3 - leitura-escrita; |
Usuário do Dashboard
Lista de permissões do painel com base em usuários. Tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| userid (required) |
string | ID do usuário. |
| permission (required) |
integer | Tipo de nível de permissão. Valores possíveis: 2 - somente leitura; 3 - leitura-escrita; |