Table of Contents
Objeto report
Os seguintes objetos estão diretamente relacionados à API report.
Relatório
O objeto relatório possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| reportid | ID | ID do relatório. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| userid | ID | ID do usuário que criou o relatório. Comportamento da propriedade: - obrigatório para operações de criação |
| name | string | Nome único do relatório. Comportamento da propriedade: - obrigatório para operações de criação |
| dashboardid | ID | ID do dashboard no qual o relatório é baseado. Comportamento da propriedade: - obrigatório para operações de criação |
| period | integer | Período para o qual o relatório será preparado. Valores possíveis: 0 - (padrão) dia anterior; 1 - semana anterior; 2 - mês anterior; 3 - ano anterior. |
| cycle | integer | Agendamento de repetição do período. Valores possíveis: 0 - (padrão) diariamente; 1 - semanalmente; 2 - mensalmente; 3 - anualmente. |
| start_time | integer | Hora do dia, em segundos, em que o relatório será preparado para envio. Padrão: 0. |
| weekdays | integer | Dias da semana para envio do relatório. Valores possíveis de bitmap: 1 - Segunda-feira; 2 - Terça-feira; 4 - Quarta-feira; 8 - Quinta-feira; 16 - Sexta-feira; 32 - Sábado; 64 - Domingo. Este é um campo de máscara de bits; qualquer soma dos valores possíveis é aceitável (por exemplo, 21 para segunda, quarta e sexta-feira). Padrão: 0. Comportamento da propriedade: - obrigatório se cycle for definido como "weekly". |
| active_since | string | Data de início. Valores possíveis: string vazia - (padrão) não especificado (armazenado como 0); data específica no formato AAAA-MM-DD (armazenada como timestamp do início do dia (00:00:00)). |
| active_till | string | Data de término. Valores possíveis: string vazia - (padrão) não especificado (armazenado como 0); data específica no formato AAAA-MM-DD (armazenada como timestamp do final do dia (23:59:59)). |
| subject | string | Assunto da mensagem do relatório. |
| message | string | Texto da mensagem do relatório. |
| status | integer | Se o relatório está habilitado ou desabilitado. Valores possíveis: 0 - Desabilitado; 1 - (padrão) Habilitado. |
| description | text | Descrição do relatório. |
| state | integer | Estado do relatório. Valores possíveis: 0 - (padrão) relatório ainda não foi processado; 1 - relatório foi gerado e enviado com sucesso para todos os destinatários; 2 - falha ao gerar o relatório; "info" contém informações sobre o erro; 3 - relatório foi gerado, mas o envio para alguns (ou todos) destinatários falhou; "info" contém informações sobre o erro. Comportamento da propriedade: - somente leitura |
| lastsent | timestamp | Timestamp Unix do último relatório enviado com sucesso. Comportamento da propriedade: - somente leitura |
| info | string | Descrição do erro ou informações adicionais. Comportamento da propriedade: - somente leitura |
Usuários
O objeto users possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| userid | ID | ID do usuário para o qual o relatório será enviado. Comportamento da propriedade: - obrigatório |
| access_userid | ID | ID do usuário em nome do qual o relatório será gerado. 0 - (padrão) Gerar relatório pelo destinatário. |
| exclude | integer | Se o usuário será excluído da lista de envio. Valores possíveis: 0 - (padrão) Incluir; 1 - Excluir. |
Grupos de usuários
O objeto de grupos de usuários possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| usrgrpid | ID | ID do grupo de usuários para o qual o relatório será enviado. Comportamento da propriedade: - obrigatório |
| access_userid | ID | ID do usuário em nome do qual o relatório será gerado. 0 - (padrão) Gerar relatório pelo destinatário. |