Documentation
Table of Contents
Objeto de informe
Los siguientes objetos están directamente relacionados con la API report.
Informe
El objeto informe tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| reportid | ID | ID del informe. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| userid | ID | ID del usuario que creó el informe. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| name | string | Nombre único del informe. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| dashboardid | ID | ID del panel en el que se basa el informe. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| period | integer | Período para el que se preparará el informe. Valores posibles: 0 - (por defecto) día anterior; 1 - semana anterior; 2 - mes anterior; 3 - año anterior. |
| cycle | integer | Programación de repetición del período. Valores posibles: 0 - (por defecto) diario; 1 - semanal; 2 - mensual; 3 - anual. |
| start_time | integer | Hora del día, en segundos, en la que se preparará el informe para su envío. Por defecto: 0. |
| weekdays | integer | Días de la semana para enviar el informe. Valores posibles de la máscara de bits: 1 - Lunes; 2 - Martes; 4 - Miércoles; 8 - Jueves; 16 - Viernes; 32 - Sábado; 64 - Domingo. Este es un campo de máscara de bits; se acepta cualquier suma de los valores posibles de la máscara de bits (por ejemplo, 21 para Lunes, Miércoles y Viernes). Por defecto: 0. Comportamiento de la propiedad: - obligatorio si cycle está establecido en "semanal". |
| active_since | string | Fecha de inicio. Valores posibles: cadena vacía - (por defecto) no especificado (almacenado como 0); fecha específica en formato AAAA-MM-DD (almacenado como una marca de tiempo del inicio del día (00:00:00)). |
| active_till | string | Fecha de finalización. Valores posibles: cadena vacía - (por defecto) no especificado (almacenado como 0); fecha específica en formato AAAA-MM-DD (almacenado como una marca de tiempo del final del día (23:59:59)). |
| subject | string | Asunto del mensaje del informe. |
| message | string | Texto del mensaje del informe. |
| status | integer | Indica si el informe está habilitado o deshabilitado. Valores posibles: 0 - Deshabilitado; 1 - (por defecto) Habilitado. |
| description | text | Descripción del informe. |
| state | integer | Estado del informe. Valores posibles: 0 - (por defecto) el informe aún no ha sido procesado; 1 - el informe fue generado y enviado correctamente a todos los destinatarios; 2 - la generación del informe falló; "info" contiene información de error; 3 - el informe fue generado, pero el envío a algunos (o todos) los destinatarios falló; "info" contiene información de error. Comportamiento de la propiedad: - solo lectura |
| lastsent | timestamp | Marca de tiempo Unix del último informe enviado con éxito. Comportamiento de la propiedad: - solo lectura |
| info | string | Descripción del error o información adicional. Comportamiento de la propiedad: - solo lectura |
Usuarios
El objeto de usuarios tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| userid | ID | ID del usuario al que enviar el informe. Comportamiento de la propiedad: - obligatorio |
| access_userid | ID | ID del usuario en cuyo nombre se generará el informe. 0 - (predeterminado) Generar informe por destinatario. |
| exclude | entero | Si se excluye al usuario de la lista de correo. Valores posibles: 0 - (predeterminado) Incluir; 1 - Excluir. |
Grupos de Usuarios
El objeto de grupos de usuarios tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| usrgrpid | ID | ID del grupo de usuarios al que enviar el informe. Comportamiento de la propiedad: - obligatorio |
| access_userid | ID | ID del usuario en cuyo nombre se generará el informe. 0 - (predeterminado) Generar informe por destinatario. |