dashboard.create

Descrição

object dashboard.create(object/array dashboards)

Este método permite criar novos dashboards.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object/array) Dashboards a serem criados.

Além das propriedades padrão do dashboard, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
pages array Páginas do dashboard a serem criadas para o dashboard. As páginas do dashboard serão ordenadas na mesma ordem em que forem especificadas.

Comportamento do parâmetro:
- obrigatório
users array Compartilhamentos de usuários do dashboard a serem criados no dashboard.
userGroups array Compartilhamentos de grupos de usuários do dashboard a serem criados no dashboard.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos dashboards criados na propriedade dashboardids. A ordem dos IDs retornados corresponde à ordem dos dashboards passados.

Exemplos

Criando um dashboard

Crie um dashboard chamado "Meu dashboard" com um widget de Problemas com tags e usando dois tipos de compartilhamento (grupo de usuários e usuário) em uma única página do dashboard.

Requisição:

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

Resposta:

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

Veja também

Fonte

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