Berichts-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der report API.

Bericht

Das Berichtsobjekt verfügt über die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
reportid ID ID des Berichts.

Eigenschaftsverhalten:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
userid ID ID des Benutzers, der den Bericht erstellt hat.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
name string Eindeutiger Name des Berichts.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
dashboardid ID ID des Dashboards, auf dem der Bericht basiert.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
period integer Zeitraum, für den der Bericht erstellt wird.

Mögliche Werte:
0 - (Standard) vorheriger Tag;
1 - vorherige Woche;
2 - vorheriger Monat;
3 - vorheriges Jahr.
cycle integer Wiederholungszeitplan des Zeitraums.

Mögliche Werte:
0 - (Standard) täglich;
1 - wöchentlich;
2 - monatlich;
3 - jährlich.
start_time integer Tageszeit in Sekunden, zu der der Bericht für den Versand erstellt wird.

Standard: 0.
weekdays integer Wochentage für den Versand des Berichts.

Mögliche Bitmap-Werte:
1 - Montag;
2 - Dienstag;
4 - Mittwoch;
8 - Donnerstag;
16 - Freitag;
32 - Samstag;
64 - Sonntag.

Dies ist ein Bitmaskenfeld; jede Summe möglicher Bitmap-Werte ist zulässig (zum Beispiel 21 für Montag, Mittwoch und Freitag).

Standard: 0.

Eigenschaftsverhalten:
- erforderlich, wenn cycle auf "weekly" gesetzt ist.
active_since string Datum, an dem der Start erfolgen soll.

Mögliche Werte:
leere Zeichenfolge - (Standard) nicht angegeben (gespeichert als 0);
spezifisches Datum im Format JJJJ-MM-TT (gespeichert als Zeitstempel des Tagesbeginns (00:00:00)).
active_till string Datum, an dem das Ende erfolgen soll.

Mögliche Werte:
leere Zeichenfolge - (Standard) nicht angegeben (gespeichert als 0);
spezifisches Datum im Format JJJJ-MM-TT (gespeichert als Zeitstempel des Tagesendes (23:59:59)).
subject string Betreff der Berichtsnachricht.
message string Text der Berichtsnachricht.
status integer Gibt an, ob der Bericht aktiviert oder deaktiviert ist.

Mögliche Werte:
0 - (Standard) aktiviert;
1 - deaktiviert.
description text Beschreibung des Berichts.
state integer Status des Berichts.

Mögliche Werte:
0 - (Standard) Bericht wurde noch nicht verarbeitet;
1 - Bericht wurde erstellt und erfolgreich an alle Empfänger gesendet;
2 - Erstellung des Berichts ist fehlgeschlagen; "info" enthält Fehlerinformationen;
3 - Bericht wurde erstellt, aber der Versand an einige oder alle Empfänger ist fehlgeschlagen; "info" enthält Fehlerinformationen.

Eigenschaftsverhalten:
- schreibgeschützt
lastsent timestamp Unix-Zeitstempel des zuletzt erfolgreich gesendeten Berichts.

Eigenschaftsverhalten:
- schreibgeschützt
info string Fehlerbeschreibung oder zusätzliche Informationen.

Eigenschaftsverhalten:
- schreibgeschützt

Benutzer

Das Benutzerobjekt hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
userid ID ID des Benutzers, an den der Bericht gesendet werden soll.

Verhalten der Eigenschaft:
- erforderlich
access_userid ID ID des Benutzers, in dessen Namen der Bericht erstellt wird.

0 - (Standard) Bericht durch den Empfänger erstellen.
exclude integer Gibt an, ob der Benutzer von der Mailingliste ausgeschlossen werden soll.

Mögliche Werte:
0 - (Standard) Einschließen;
1 - Ausschließen.

Benutzergruppen

Das Benutzergruppen-Objekt hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
usrgrpid ID ID der Benutzergruppe, an die der Bericht gesendet wird.

Verhalten der Eigenschaft:
- erforderlich
access_userid ID ID des Benutzers, in dessen Namen der Bericht erstellt wird.

0 - (Standard) Bericht nach Empfänger erstellen.