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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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 las operaciones de creaci¨®n |
| name | cadena | Nombre ¨²nico del informe. Comportamiento de la propiedad: - obligatorio para operaciones de creaci¨®n |
| dashboardid | ID | ID del tablero en el que se basa el informe. Comportamiento de la propiedad: - obligatorio para operaciones de creaci¨®n |
| period | entero | 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. |
| cycle | entero | Programaci¨®n de repetici¨®n de per¨ªodo. Valores posibles: 0 - (predeterminado) diario; 1 - semanal; 2 - mensual; 3 - anual . |
| start_time | entero | Hora del d¨ªa, en segundos, en la que se preparar¨¢ el informe para su env¨ªo. Valor predeterminado: 0. |
| weekdays | entero | D¨ªas de la semana para enviar el informe. 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. Comportamiento de la propiedad: - obligatorio si ciclo est¨¢ configurado en "semanal". |
| active_since | cadena | 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 | cadena | 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)). |
| subject | cadena | Reportar asunto del mensaje. |
| message | cadena | Reportar texto del mensaje. |
| status | entero | Si el informe est¨¢ habilitado o deshabilitado. Valores posibles: 0 - Deshabilitado; 1 - (predeterminado) Habilitado. |
| description | texto | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô del informe. |
| state | entero | Estado del informe. Valores posibles: 0 - (predeterminado) el informe a¨²n no se proces¨®; 1 - el informe se gener¨® y se envi¨® correctamente 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. Comportamiento de la propiedad: - solo lectura |
| lastsent | marca de tiempo | Marca de tiempo Unix del ¨²ltimo informe enviado exitosamente. Comportamiento de la propiedad: - solo lectura |
| info | cadena | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô del error o informaci¨®n adicional. Comportamiento de la propiedad: - solo lectura |
Usuarios
El objeto de usuarios tiene las siguientes propiedades:
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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. |