painel.get

Descrição

integer/array dashboard.get(object parameters)

O método permite recuperar dashboards de acordo com os dados parâmetros.

Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método oferece suporte aos seguintes parâmetros.

Parâmetro Tipo Descrição
dashboardids string/array Retorne apenas painéis com os IDs fornecidos.
selectPages query Retorne uma propriedade pages com páginas do painel, ordenadas corretamente.
selectUsers query Retorne uma propriedade users com os usuários com os quais o painel é compartilhado.
selectUserGroups query Retorne uma propriedade userGroups com grupos de usuários com os quais o painel é compartilhado.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

O valor possível é: dashboardid.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes na página comentário de referência.
editável booleano
excludePesquisa boolean
filtro objeto
limite inteiro
saída consulta
preservekeys boolean
pesquisar objeto
searchByAny boolean
searchWildcardsEnabled boolean
ordem de classificação cadeia/matriz
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • uma matriz de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando um painel por ID

Recupere todos os dados sobre os painéis "1" e "2".

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "dashboard.get",
    "parâmetros": {
        "saída": "estender",
        "selectPages": "estender",
        "selectUsers": "estender",
        "selectUserGroups": "estender",
        "dashboardids": [
            "1",
            "2"
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "dashboardid": "1",
            "nome": "Painel",
            "userid": "1",
            "privado": "0",
            "display_period": "30",
            "auto_start": "1",
            "Comercial": [],
            "userGroups": [],
            "Páginas": [
                {
                    "dashboard_pageid": "1",
                    "nome": "",
                    "display_period": "0",
                    "widgets": [
                        {
                            "widgetid": "9",
                            "tipo": "informações do sistema",
                            "nome": "",
                            "x": "12",
                            "y": "8",
                            "largura": "12",
                            "altura": "5",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "8",
                            "type": "problemsbysv",
                            "nome": "",
                            "x": "12",
                            "s": "4",
                            "largura": "12",
                            "altura": "4",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "7",
                            "type": "hosts do problema",
                            "nome": "",
                            "x": "12",
                            "y": "0",
                            "largura": "12",
                            "altura": "4",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "6",
                            "tipo": "descoberta",
                            "nome": "",
                            "x": "6",
                            "s": "9",
                            "largura": "6",
                            "altura": "4",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "5",
                            "tipo": "web",
                            "nome": "",
                            "x": "0",
                            "s": "9",
                            "largura": "6",
                            "altura": "4",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "4",
                            "tipo": "problemas",
                            "nome": "",
                            "x": "0",
                            "s": "3",
                            "largura": "12",
                            "altura": "6",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "3",
                            "type": "favmaps",
                            "nome": "",
                            "x": "8",
                            "y": "0",
                            "largura": "4",
                            "altura": "3",
                            "view_mode": "0",
                            "Campos": []
                        },
                        {
                            "widgetid": "1",
                            "type": "favgraphs",
                            "nome": "",
                            "x": "0",
                            "y": "0",
                            "largura": "4",
                            "altura": "3",
                            "view_mode": "0",
                            "Campos": []
                        }
                    ]
                },
                {
                    "dashboard_pageid": "2",
                    "nome": "",
                    "display_period": "0",
                    "widgets": []
                },
                {
                    "dashboard_pageid": "3",
                    "name": "Nome da página personalizada",
                    "display_period": "60",
                    "widgets": []
                }
            ]
        },
        {
            "dashboardid": "2",
            "name": "Meu painel",
            "userid": "1",
            "privado": "1",
            "display_period": "60",
            "auto_start": "1",
            "Comercial": [
                {
                    "userid": "4",
                    "permissão": "3"
                }
            ],
            "userGroups": [
                {
                    "usrgrpid": "7",
                    "permissão": "2"
                }
            ],
            "Páginas": [
                {
                    "dashboard_pageid": "4",
                    "nome": "",
                    "display_period": "0",
                    "widgets": [
                        {
                            "widgetid": "10",
                            "tipo": "problemas",
                            "nome": "",
                            "x": "0",
                            "y": "0",
                            "largura": "12",
                            "altura": "5",
                            "view_mode": "0",
                            "Campos": [
                                {
                                    "tipo 2",
                                    "nome": "grupoids",
                                    "valor": "4"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}

Veja também

Fonte

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