Table of Contents
> Rapporteer object
De volgende objecten zijn direct gerelateerd aan de report API.
Rapport
Het rapportobject heeft de volgende eigenschappen:
| Eigenschap | Type | Omschrijving |
|---|---|---|
| reportid | string | (alleen-lezen) ID van het rapport. |
| userid (verplicht) |
string | ID van de gebruiker die het rapport heeft gemaakt. |
| name (verplicht) |
string | Unieke naam van het rapport. |
| dashboardid (verplicht) |
string | ID van het dashboard waarop het rapport is gebaseerd. |
| period | integer | Periode waarvoor het rapport zal worden opgesteld. Mogelijke waarden: 0 - (standaard) vorige dag; 1 - vorige week; 2 - vorige maand; 3 - vorig jaar. |
| cycle | integer | Herhalingsschema voor de periode. Mogelijke waarden: 0 - (standaard) dagelijks; 1 - wekelijks; 2 - maandelijks; 3 - jaarlijks. |
| start_time | integer | Tijdstip van de dag, in seconden, wanneer het rapport zal worden opgesteld om te verzenden. Standaard: 0. |
| weekdays | integer | Dagen van de week om het rapport te verzenden. Vereist alleen voor wekelijkse rapporten. Dagen van de week worden binair opgeslagen, waarbij elke bit de overeenkomstige dag van de week vertegenwoordigt. Bijvoorbeeld, 12 staat voor 1100 in binair en betekent dat rapporten elke woensdag en donderdag worden verzonden. Standaard: 0. |
| active_since | string | Op welke datum te starten. Mogelijke waarden: lege string - (standaard) niet gespecificeerd (opgeslagen als 0); specifieke datum in het formaat YYYY-MM-DD (opgeslagen als een tijdstempel van het begin van een dag (00:00:00)). |
| active_till | string | Op welke datum te eindigen. Mogelijke waarden: lege string - (standaard) niet gespecificeerd (opgeslagen als 0); specifieke datum in het formaat YYYY-MM-DD (opgeslagen als een tijdstempel van het einde van een dag (23:59:59)). |
| subject | string | Onderwerp van het rapportbericht. |
| message | string | Tekst van het rapportbericht. |
| status | integer | Of het rapport is ingeschakeld of uitgeschakeld. Mogelijke waarden: 0 - Uitgeschakeld; 1 - (standaard) Ingeschakeld. |
| description | tekst | Beschrijving van het rapport. |
| state | integer | (alleen-lezen) Status van het rapport. Mogelijke waarden: 0 - (standaard) rapport is nog niet verwerkt; 1 - rapport is gegenereerd en succesvol naar alle ontvangers verzonden; 2 - genereren van rapport is mislukt; "info" bevat foutinformatie; 3 - rapport is gegenereerd, maar verzenden naar sommige (of alle) ontvangers is mislukt; "info" bevat foutinformatie. |
| lastsent | tijdstempel | (alleen-lezen) Unix-tijdstempel van het laatst succesvol verzonden rapport. |
| info | string | (alleen-lezen) Foutomschrijving of aanvullende informatie. |
Merk op dat voor sommige methoden (update, delete) de vereiste/optionele parametercombinatie anders is.
Gebruikers
Het gebruikersobject heeft de volgende eigenschappen:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| use-ID (vereist) |
string | ID van de gebruiker waarnaar het rapport moet worden verzonden. |
| access_userid | string | ID van de gebruiker namens wie het rapport wordt gegenereerd. 0 - (standaard) Rapport genereren per ontvanger. |
| exclude | integer | Of de gebruiker moet worden uitgesloten van de mailinglijst. Mogelijke waarden: 0 - (standaard) Opnemen; 1 - Uitsluiten. |
Gebruikersgroepen
Het gebruikersgroepenobject heeft de volgende eigenschappen:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| usrgrpid (vereist) |
string | ID van gebruikersgroep waarnaar het rapport moet worden verzonden. |
| access_userid | string | ID van de gebruiker namens wie het rapport wordt gegenereerd. 0 - (standaard) Rapport genereren per ontvanger. |