Pārskata objekts

Tālāk norādītie objekti ir tieši saistīti ar report API.

Atskaite

Atskaites objektam ir šādas īpašības:

Property Type Description
reportid ID Atskaites ID.

Property behavior:
- read-only
- required atjaunināšanas operācijām
userid ID Lietotāja ID, kurš izveidoja atskaiti.

Property behavior:
- required izveides operācijām
name string Unikāls atskaites nosaukums.

Property behavior:
- required izveides operācijām
dashboardid ID Paneļa ID, uz kura pamata atskaite ir izveidota.

Property behavior:
- required izveides operācijām
period integer Periods, par kuru tiks sagatavota atskaite.

Iespējamās vērtības:
0 - (noklusējums) iepriekšējā diena;
1 - iepriekšējā nedēļa;
2 - iepriekšējais mēnesis;
3 - iepriekšējais gads.
cycle integer Perioda atkārtošanās grafiks.

Iespējamās vērtības:
0 - (noklusējums) katru dienu;
1 - katru nedēļu;
2 - katru mēnesi;
3 - katru gadu.
start_time integer Diennakts laiks sekundēs, kad atskaite tiks sagatavota nosūtīšanai.

Noklusējums: 0.
weekdays integer Nedēļas dienas atskaites nosūtīšanai.

Iespējamās bitkartes vērtības:
1 - pirmdiena;
2 - otrdiena;
4 - trešdiena;
8 - ceturtdiena;
16 - piektdiena;
32 - sestdiena;
64 - svētdiena.

Šis ir bitmaskas lauks; ir pieļaujama jebkura iespējamo bitkartes vērtību summa (piemēram, 21 pirmdienai, trešdienai un piektdienai).

Noklusējums: 0.

Property behavior:
- required ja cycle ir iestatīts uz "weekly".
active_since string Datums, no kura sākt.

Iespējamās vērtības:
tukša virkne - (noklusējums) nav norādīts (glabājas kā 0);
konkrēts datums YYYY-MM-DD formātā (glabājas kā dienas sākuma laikspiedols (00:00:00)).
active_till string Datums, līdz kuram beigt.

Iespējamās vērtības:
tukša virkne - (noklusējums) nav norādīts (glabājas kā 0);
konkrēts datums YYYY-MM-DD formātā (glabājas kā dienas beigu laikspiedols (23:59:59)).
subject string Atskaites ziņojuma tēma.
message string Atskaites ziņojuma teksts.
status integer Vai atskaite ir iespējota vai atspējota.

Iespējamās vērtības:
0 - Atspējota;
1 - (noklusējums) Iespējota.
description text Atskaites apraksts.
state integer Atskaites stāvoklis.

Iespējamās vērtības:
0 - (noklusējums) atskaite vēl nav apstrādāta;
1 - atskaite tika ģenerēta un veiksmīgi nosūtīta visiem saņēmējiem;
2 - atskaites ģenerēšana neizdevās; "info" satur kļūdas informāciju;
3 - atskaite tika ģenerēta, bet nosūtīšana dažiem (vai visiem) saņēmējiem neizdevās; "info" satur kļūdas informāciju.

Property behavior:
- read-only
lastsent timestamp Pēdējās veiksmīgi nosūtītās atskaites Unix laikspiedols.

Property behavior:
- read-only
info string Kļūdas apraksts vai papildu informācija.

Property behavior:
- read-only

Lietotāji

Lietotāju objektam ir šādas īpašības:

Īpašība Tips Apraksts
userid ID Lietotāja ID, kuram nosūtīt atskaiti.

Īpašības darbība:
- obligāts
access_userid ID Lietotāja ID, kura vārdā tiks ģenerēta atskaite.

0 - (noklusējums) Ģenerēt atskaiti saņēmēja vārdā.
exclude integer Vai izslēgt lietotāju no adresātu saraksta.

Iespējamās vērtības:
0 - (noklusējums) Iekļaut;
1 - Izslēgt.

Lietotāju grupas

Lietotāju grupu objektam ir šādas īpašības:

Īpašība Tips Apraksts
usrgrpid ID Lietotāju grupas ID, kurai nosūtīt atskaiti.

Īpašības darbība:
- obligāts
access_userid ID Lietotāja ID, kura vārdā tiks ģenerēta atskaite.

0 - (noklusējums) Ģenerēt atskaiti saņēmēja vārdā.