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 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 Descripción 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 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.