Pārskata objekts

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

Pārskats

Pārskata objektam ir šādas īpašības:

Property Type Description
reportid ID Pārskata ID.

Īpašības darbība:
- tikai lasāms
- obligāts atjaunināšanas darbībām
userid ID Lietotāja, kurš izveidoja pārskatu, ID.

Īpašības darbība:
- obligāts izveides darbībām
name string Unikāls pārskata nosaukums.

Īpašības darbība:
- obligāts izveides darbībām
dashboardid ID Informācijas paneļa ID, uz kura pamata tiek veidots pārskats.

Īpašības darbība:
- obligāts izveides darbībām
period integer Periods, par kuru tiks sagatavots pārskats.

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 Periodisks atkārtošanas 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 Dienas laiks sekundēs, kad pārskats tiks sagatavots nosūtīšanai.

Noklusējums: 0.
weekdays integer Nedēļas dienas, kurās nosūtīt pārskatu.

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ņemama jebkura iespējamo bitkartes vērtību summa (piemēram, 21 pirmdienai, trešdienai un piektdienai).

Noklusējums: 0.

Īpašības darbība:
- obligāts, 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 (tiek saglabāts kā 0);
konkrēts datums formātā YYYY-MM-DD (tiek saglabāts kā dienas sākuma laika zīmogs (00:00:00)).
active_till string Datums, kurā beigt.

Iespējamās vērtības:
tukša virkne - (noklusējums) nav norādīts (tiek saglabāts kā 0);
konkrēts datums formātā YYYY-MM-DD (tiek saglabāts kā dienas beigu laika zīmogs (23:59:59)).
subject string Pārskata ziņojuma temats.
message string Pārskata ziņojuma teksts.
status integer Norāda, vai pārskats ir iespējots vai atspējots.

Iespējamās vērtības:
0 - (noklusējums) iespējots;
1 - atspējots.
description text Pārskata apraksts.
state integer Pārskata stāvoklis.

Iespējamās vērtības:
0 - (noklusējums) pārskats vēl nav apstrādāts;
1 - pārskats ir ģenerēts un veiksmīgi nosūtīts visiem adresātiem;
2 - pārskata ģenerēšana neizdevās; laukā "info" ir ietverta informācija par kļūdu;
3 - pārskats ir ģenerēts, taču nosūtīšana dažiem (vai visiem) adresātiem neizdevās; laukā "info" ir ietverta informācija par kļūdu.

Īpašības darbība:
- tikai lasāms
lastsent timestamp Pēdējā veiksmīgi nosūtītā pārskata Unix laika zīmogs.

Īpašības darbība:
- tikai lasāms
info string Kļūdas apraksts vai papildu informācija.

Īpašības darbība:
- tikai lasāms

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ā.