report.update

Descrição

object report.update(object/array reports)

Este método permite atualizar relatórios agendados existentes.

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) Propriedades do relatório agendado a serem atualizadas.

A propriedade reportid deve ser definida para cada relatório agendado, todas as outras propriedades são opcionais. Somente as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas.

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

Parâmetro	Tipo	Descrição
users	object/array	Usuários para substituir os usuários atuais atribuídos ao relatório agendado. Comportamento do parâmetro: - obrigatório se `user_groups` não estiver definido
user_groups	object/array	Grupos de usuários para substituir os grupos de usuários atuais atribuídos ao relatório agendado. 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 atualizados na propriedade reportids.

Exemplos

Desabilitando relatório agendado

Requisição:

{
           "jsonrpc": "2.0",
           "method": "report.update",
           "params": {
               "reportid": "1",
               "status": "0"
           },
           "id": 1
       }

Resposta:

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

Veja também

Origem

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

Documentation