Documentation
Table of Contents
> 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 | string | (només lectura) ID de l'informe. |
| userid (obligatori) |
string | ID de l'usuari que ha creat l'informe. |
| name (obligatori) |
string | Nom únic de l'informe. |
| dashboardid (obligatori) |
string | ID del tauler de control en què es basa l'informe. |
| 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 | enter | 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. Només es requereix per als informes setmanals. 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. És un camp de màscara de bit; s'admet qualsevol suma de possibles valors de mapa de bits (per exemple, 21 per Dilluns, Dimecres i Divendres). Per defecte: 0. |
| active_since | string | A quina data 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 | A quina data s'ha d'acabar. Valors possibles: cadena buida - (per defecte) sense especificar (emmagatzemat com a 0); data específica per a YYYY-MM- Format 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 | ingeter | Indica si l'informe és actiu o desactivat. Valors possibles: 0 - Desactivat; 1 - (per defecte) Activat. |
| description | text | Descripció de l'informe. |
| state | integer | (només lectura) 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. |
| lastsent | timestamp | (només lectura) Marca de temps de Unix del darrer informe enviat correctament. |
| info | string | (només lectura) Descripció de l'error o informació addicional. |
Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.
Usuaris
L'objecte té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| userid (obligatori) |
string | ID de l'usuari a qui enviar l'informe. |
| access_userid | string | 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 (obligatori) |
string | ID del grup d'usuaris a qui enviar l'informe. |
| access_userid | string | ID de l'usuari en nom del qual es generarà l'informe. 0 - (per defecte) Genereu un informe per destinatari. |