Objeto report

Los siguientes objetos están directamente relacionados con la API report.

Informe

El objeto de informe tiene las siguientes propiedades:

Property Type Description
reportid ID ID del informe.

Comportamiento de la propiedad:
- solo lectura
- obligatoria para las operaciones de actualización
userid ID ID del usuario que creó el informe.

Comportamiento de la propiedad:
- obligatoria para las operaciones de creación
name string Nombre único del informe.

Comportamiento de la propiedad:
- obligatoria para las operaciones de creación
dashboardid ID ID del dashboard en el que se basa el informe.

Comportamiento de la propiedad:
- obligatoria para las operaciones de creación
period integer Período para el que se preparará el informe.

Valores posibles:
0 - (predeterminado) 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 - (predeterminado) diariamente;
1 - semanalmente;
2 - mensualmente;
3 - anualmente.
start_time integer Hora del día, en segundos, a la que se preparará el informe para su envío.

Predeterminado: 0.
weekdays integer Días de la semana para enviar el informe.

Valores de bitmap posibles:
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 de bitmap posibles (por ejemplo, 21 para lunes, miércoles y viernes).

Predeterminado: 0.

Comportamiento de la propiedad:
- obligatoria si cycle está establecido en "weekly".
active_since string Fecha a partir de la cual se iniciará.

Valores posibles:
cadena vacía - (predeterminado) no especificada (se almacena como 0);
fecha específica en formato YYYY-MM-DD (se almacena como una marca de tiempo del inicio del día (00:00:00)).
active_till string Fecha en la que finalizará.

Valores posibles:
cadena vacía - (predeterminado) no especificada (se almacena como 0);
fecha específica en formato YYYY-MM-DD (se almacena 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 - (predeterminado) habilitado;
1 - deshabilitado.
description text Descripción del informe.
state integer Estado del informe.

Valores posibles:
0 - (predeterminado) el informe aún no se ha procesado;
1 - el informe se generó y se envió correctamente a todos los destinatarios;
2 - no se pudo generar el informe; "info" contiene información sobre el error;
3 - el informe se generó, pero no se pudo enviar a algunos (o a todos) los destinatarios; "info" contiene información sobre el error.

Comportamiento de la propiedad:
- solo lectura
lastsent timestamp Marca de tiempo de Unix del último informe enviado correctamente.

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 usuarios tiene las siguientes propiedades:

Propiedad Tipo Descripción
userid ID ID del usuario al que se enviará el informe.

Comportamiento de la propiedad:
- obligatorio
access_userid ID ID del usuario en cuyo nombre se generará el informe.

0 - (por defecto) Generar informe por destinatario.
exclude integer Si se debe excluir al usuario de la lista de correo.

Valores posibles:
0 - (por defecto) 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 se enviará el informe.

Comportamiento de la propiedad:
- obligatorio
access_userid ID ID del usuario en cuyo nombre se generará el informe.

0 - (por defecto) Generar informe por destinatario.