This is a translation of the original English documentation page. Help us make it better.

> Rapporteer object

De volgende objecten zijn direct gerelateerd aan de report API.

Rapport

Het rapportobject heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
reportid string ID van het rapport.

Eigenschapsgedrag:
- alleen-lezen
- vereist voor update-operaties
userid string ID van de gebruiker die het rapport heeft gemaakt.

Eigenschapsgedrag:
- vereist voor maakoperaties
name string Unieke naam van het rapport.

Eigenschapsgedrag:
- vereist voor maakoperaties
dashboardid string ID van het dashboard waarop het rapport is gebaseerd.

Eigenschapsgedrag:
- vereist voor maakoperaties
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 Tijd van de dag, in seconden, waarop het rapport wordt voorbereid om te verzenden.

Standaard: 0.
weekdays integer Dagen van de week voor het verzenden van het rapport.

Dagen van de week worden in binaire vorm opgeslagen, waarbij elke bit de overeenkomstige dag van de week vertegenwoordigt. Bijvoorbeeld, 12 komt overeen met 1100 in binair en betekent dat rapporten elke woensdag en donderdag worden verzonden.

Standaard: 0.

Eigenschapsgedrag:
- vereist als cycle is ingesteld op "wekelijks".
active_since string Op welke datum te starten.

Mogelijke waarden:
lege tekenreeks - (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 tekenreeks - (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 Status van het rapport.

Mogelijke waarden:
0 - (standaard) rapport is nog niet verwerkt;
1 - rapport is gegenereerd en succesvol verzonden naar alle ontvangers;
2 - genereren van rapport mislukt; "info" bevat foutinformatie;
3 - rapport is gegenereerd, maar verzenden naar sommige (of alle) ontvangers is mislukt; "info" bevat foutinformatie.

Eigenschapsgedrag:
- alleen-lezen
lastsent tijdstempel Unix-tijdstempel van het laatst succesvol verzonden rapport.

Eigenschapsgedrag:
- alleen-lezen
info string Foutomschrijving of aanvullende informatie.

Eigenschapsgedrag:
- alleen-lezen

Gebruikers

Het object met gebruikers heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
userid string ID van de gebruiker aan wie het rapport moet worden verzonden.

Eigenschapsgedrag:
- vereist
access_userid string ID van de gebruiker namens wie het rapport wordt gegenereerd.

0 - (standaard) Rapport genereren namens ontvanger.
exclude integer Of de gebruiker moet worden uitgesloten van de verzendlijst.

Mogelijke waarden:
0 - (standaard) Inclusief;
1 - Uitsluiten.

Gebruikersgroepen

Het object met gebruikersgroepen heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
usrgrpid string ID van de gebruikersgroep aan wie het rapport moet worden verzonden.

Eigenschapsgedrag:
- vereist
access_userid string ID van de gebruiker namens wie het rapport wordt gegenereerd.

0 - (standaard) Rapport genereren namens ontvanger.