Documentation
Table of Contents
Пријавите објекат
Следећи објекти су директно повезани са API-јем за report.
Извештај
Објекат извештаја има следећа својства:
| Property | Type | Description |
|---|---|---|
| reportid | ID | ID извештаја . Понашање својства: - само за читање - обавезно за операције ажурирања |
| userid | ID | ID корисника који је креирао извештај. Понашање својства: - потребно за операције креирања |
| name | string | Јединствено име извештај. Понашање својства: - потребно за операције креирања |
| dashboardid | ID | ID контролне табле на којој је извештај на основу. Понашање својства: - потребно за операције креирања |
| period | integer | Период за који ће бити припремљен извештај . Могуће вредности: 0 - (подразумевано) претходни дан; 1 - претходна недеља; 2 - претходни месец; 3 - претходна година. |
| cycle | integer | Распоред понављања периода. Могуће вредности: 0 - (подразумевано) дневно; 1 - недељно; 2 - месечно; 3 - годишње. |
| start_time | integer | Време дана, у секундама, када ће извештај бити припремљен за слање. <бр>Подразумевано: 0. |
| weekdays | integer | Дани у недељи за слање извештаја. Могуће битмап вредности: 1 - понедељак; 2 - уторак; 4 - среда; 8 - четвртак; 16 - петак; 32 - субота ; 64 - недеља. Ово је поље битмаске; било који збир могућих битмап вредности је прихватљив (на пример, 21 за понедељак, среду и петак). Подразумевано: 0. Понашање својства: - обавезно ако је циклус подешен на "недељни". |
|active_since|string|На који датум да почне.
Могуће вредности:
празно стринг - (подразумевано) није наведено (чува се као 0);
одређени датум у ГГГГ-ММ-ДД формату (чува се као временска ознака почетка дана (00:00:00)).| |active_till|stringг|Којег датума се завршава.
Могуће вредности:
празан стринг - (подразумевано) није наведено (чувано као 0);
одређени датум у ГГГГ-ММ-ДД формат (чува се као временска ознака краја дана (23:59:59).| |subject|string|Извештај о теми поруке.| |message|string|Текст поруке.| |status|integer|Да ли је извештај је омогућено или онемогућено.
Могуће вредности:
0 - Онемогућено;
1 - (подразумевано) Омогућено.| |description|text|Опис извештаја.| |state|integer| Стање извештаја.
Могуће вредности:
0 - (подразумевано) извештај још није обрађен;
1 - извештај је генерисан и успешно послат свим примаоцима;
2 - генерисање извештаја није успело; "info" садржи информације о грешци;
3 – извештај је генерисан, али слање неким (или свим) примаоцима није успело; "info" садржи информације о грешци.
Понашање својства:
- само за читање| |lastsent|timestamp|Уникс временска ознака последњег извештај успешно послат.
Понашање својства:
- само за читање| |info|string|Опис грешке или додатне информације.<br >
Понашање својства:
- само за читање|
Корисници
Објекат корисника има следећа својства:
| Property | Type | Description |
|---|---|---|
| userid | ID | ID корисника коме пошаљи извештај на. Понашање својства: - обавезно |
| access_userid | ID | ID корисника у чије име извештај ће бити генерисан. 0 - (подразумевано) Генериши извештај према примаоцу. |
| exclude | integer | Да ли да се искључи корисник са листе слања. Могуће вредности: 0 - (подразумевано) Укључи; 1 - Искључи. |
Групе корисника
Објекат корисничке групе има следећа својства:
| Property | Type | Description |
|---|---|---|
| usrgrpid | ID | ID корисника група којој треба послати извештај. Понашање својства: - обавезно |
| access_userid | ID | ID корисника у чије име ће бити генерисан извештај. 0 - (подразумевано) Генериши извештај према примаоцу. |