templatedashboard.create

Descrição

object templatedashboard.create(object/array templateDashboards)

Este método permite criar novos dashboards de template.

Este método está disponível apenas para os tipos de usuário Admin e Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object/array) Dashboards de template a serem criados.

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

Parâmetro Tipo Descrição
pages array Páginas de dashboard de template a serem criadas para o dashboard. As páginas do dashboard serão ordenadas na mesma ordem especificada.

Comportamento do parâmetro:
- obrigatório

Valores de retorno

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

Exemplos

Criando um dashboard de template

Crie um dashboard de template chamado "Graphs" com um widget Graph em uma única página do dashboard.

Request:

{
    "jsonrpc": "2.0",
    "method": "templatedashboard.create",
    "params": {
        "templateid": "10318",
        "name": "Graphs",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "graph",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 6,
                                "name": "graphid",
                                "value": "1123"
                            }
                        ]
                    }
                ]

            }
        ]
    },
    "id": 1
}

Response:

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

Veja também

Fonte

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