Objecte informe

Els següents objectes són relacionats amb l'API report.

Informe

L'objecte té les propietats següents:

Propietat Tipus Descripció
reportid ID ID de l'informe.

Comportament de la propietat:
- només lectura
- obligatori per operacions d'actualització
userid ID ID de l'usuari que ha creat l'informe.

Comportament de la propietat:
- obligatori per operacions de creació
name string Nom únic de l'informe.

Comportament de la propietat:
- obligatori per operacions de creació
dashboardid ID ID del tauler de control en què es basa l'informe.

Comportament de la propietat:
- obligatori per operacions de creació
period integer Període per al qual s'elaborarà l'informe.

Valors possibles:
0 - (per defecte) dia anterior;
1 - setmana anterior;
2 - anterior mes;
3 - any anterior.
cycle integer Programació de repetició del període.

Valors possibles:
0 - (per defecte) diari;
1 - setmanal;
2 - mensual;<br >3 - anual.
start_time integer Hora del dia, en segons, en què es prepararà l'informe per enviar-lo.

Per defecte: 0.
weekdays integer Dies de la setmana per enviar l'informe.

Els dies de la setmana s'emmagatzemen en forma binària, amb cada bit que representa el dia corresponent de la setmana. Per exemple, 12 és igual a 1100 en binari i vol dir que s'enviaran informes cada dimecres i dijous.

Per defecte: 0.

Comportament de la propietat:
- obligatori si cycle és "weekly".
active_since string Quan ha de començar.

Valors possibles:
cadena buida - (per defecte) sense especificar (emmagatzemat com a 0);
data específica del format AAAA-MM-DD (emmagatzemat com a marca de temps d'inici del dia (00:00:00)).
active_till string Quan ha d'acabar.

Valors possibles:
cadena buida - (per defecte) sense especificar (emmagatzemat com a 0);
data específica en format YYYY-MM-DD (emmagatzemat com a marca de temps del final del dia (23:59:59)).
subject string Assumpte del missatge de l'informe.
message string Informa del text del missatge.
status integer Indica si l'informe és actiu o desactivat.

Valors possibles:
0 - Desactivat;
1 - (per defecte) Activat.
description text Descripció de l'informe.
state integer Estat de l'informe.

Valors possibles:
0 - (per defecte) l'informe encara no s'ha processat;
1 - informe generat enviat correctament a tots els destinataris;
2 - no s'ha pogut generar l'informe; "info" conté informació d'error;
3 - s'ha generat l'informe, però no s'ha pogut enviar a alguns (o a tots) els destinataris; "info" conté informació d'error.

Comportament de la propietat:
- només lectura
lastsent timestamp Marca de temps de Unix del darrer informe enviat correctament.

Comportament de la propietat:
- només lectura
info string Descripció de l'error o informació addicional.

Comportament de la propietat:
- només lectura

Usuaris

L'objecte té les propietats següents:

Propietat Tipus Descripció
userid ID ID de l'usuari a qui enviar l'informe.

Comportament de la propietat:
- obligatori
access_userid ID ID de l'usuari en nom del qual es generarà l'informe.

0 - (per defecte) Genereu un informe per destinatari.
exclude integer Indica si s'ha d'excloure l'usuari de la llista de correu.

Valors possibles:
0 - (per defecte) Incloure;
1 - Excloure.

Grups d'usuaris

L'objecte té les propietats següents:

Propietat Tipus Descripció
usergrpid ID ID del grup d'usuaris a qui enviar l'informe.

Comportament de la propietat:
- obligatori
access_userid ID ID de l'usuari en nom del qual es generarà l'informe.

0 - (per defecte) Genereu un informe per destinatari.