Documentation
Table of Contents
> Objeto de informe
Los siguientes objetos están directamente relacionados con la API report.
Informe
El objeto de informe tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| reportid | string | (readonly) ID del informe. |
| userid (obligatorio) |
cadena | ID del usuario que creó el informe. |
| nombre (obligatorio) |
cadena | Nombre único del informe. |
| dashboardid (obligatorio) |
cadena | ID del panel en el que se basa el informe. |
| period | integer | Período para el cual se preparará el informe. Valores posibles: 0 - (predeterminado) día anterior; 1 - semana anterior; 2 - anterior mes; 3 - año anterior. |
| ciclo | entero | Programación de repetición de período. Valores posibles: 0 - (predeterminado) 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. Valor predeterminado: 0. |
| weekdays | integer | Días de la semana para enviar el informe. Obligatorio solo para informes semanales. Los días de la semana se almacenan en formato binario y cada bit representa el día de la semana correspondiente. Por ejemplo, 12 equivale a 1100 en binario y significa que los informes se enviarán todos los miércoles y jueves. Valor predeterminado: 0. |
| active_since | string | En qué fecha comenzar. Valores posibles: cadena vacía - (predeterminado) no especificado (almacenado como 0); fecha específica en AAAA-MM -Formato DD (almacenado como marca de tiempo del comienzo de un día (00:00:00)). |
| active_till | string | En qué fecha finalizar. Valores posibles: cadena vacía - (predeterminado) no especificado (almacenado como 0); fecha específica en AAAA-MM -Formato DD (almacenado como marca de tiempo del final de un día (23:59:59)). |
| asunto | cadena | Reportar asunto del mensaje. |
| mensaje | cadena | Reportar texto del mensaje. |
| status | entero | Si el informe está habilitado o deshabilitado. Valores posibles: 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
| descripción | texto | Descripción del informe. |
| state | integer | (solo lectura) Estado del informe. Valores posibles: 0 - (predeterminado) el informe aún no se procesó; 1: el informe se generó y se realizó correctamente enviado a todos los destinatarios; 2: error al generar el informe; "info" contiene información de error; 3: se generó el informe, pero falló el envío a algunos (o todos) los destinatarios; "info" contiene información de error. |
| último envío | marca de tiempo | (solo lectura) Marca de tiempo Unix del último informe enviado correctamente. |
| info | string | (readonly) Descripción del error o información adicional. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.
Usuarios
El objeto de usuarios tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| userid (obligatorio) |
cadena | ID del usuario al que enviar el informe. |
| access_userid | cadena | 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 (obligatorio) |
cadena | ID del grupo de usuarios al que enviar el informe. |
| access_userid | cadena | ID del usuario en cuyo nombre se generará el informe. 0 - (predeterminado) Generar informe por destinatario. |