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

Parâmetros

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

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

Parâmetro	Tipo	Descrição
users	object/array	Usuários para enviar o relatório. Comportamento do parâmetro: - obrigatório se `user_groups` não estiver definido
user_groups	object/array	Grupos de usuários para enviar o relatório. Comportamento do parâmetro: - obrigatório se `users` não estiver definido

Valores de retorno

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

Exemplos

Criando um relatório agendado

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

Requisição:

{
           "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"
                   }
               ]
           },
           "id": 1
       }

Resposta:

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

Veja também

Origem

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

Documentation