report.create

Descrição

object report.create(object/array reports)

Este método permite criar novos relatórios agendados.

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 do usuário. Consulte Funções de usuário para obter mais informações.

Parâmetros

(object/array) Relatórios programados para criar.

Além das propriedades de relatório agendado padrão, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
users object/array de objetos Usuários para quem enviar o relatório.
user_groups object/array de objetos Grupos de usuários para os quais enviar o relatório.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos relatórios programados criados na propriedade reportids. A ordem dos IDs retornados corresponde à ordem dos relatórios programados passados.

Exemplos

Criando um relatório programado

Crie um relatório semanal que será preparado para a semana anterior de segunda a sexta-feira às 12:00 de 01-04-2021 a 31-08-2021.

Request:

{
    "jsonrpc": "2.0",
    "method": "report.create",
    "params": {
        "userid": "1",
        "name": "Weekly report",
        "dashboardid": "1",
        "period": "1",
        "cycle": "1",
        "start_time": "43200",
        "weekdays": "31",
        "active_since": "2021-04-01",
        "active_till": "2021-08-31",
        "subject": "Weekly report",
        "message": "Report accompanying text",
        "status": "1",
        "description": "Report description",
        "users": [
            {
                "userid": "1",
                "access_userid": "1",
                "exclude": "0"
            },
            {
                "userid": "2",
                "access_userid": "0",
                "exclude": "1"
            }
        ],
        "user_groups": [
            {
                "usrgrpid": "7",
                "access_userid": "0"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

Veja também

Fonte

CReport::create() in ui/include/classes/api/services/CReport.php.