report.get

Leírás

integer/array report.get(objektumparaméterek)

A metódus lehetővé teszi az ütemezett jelentések lekérését a megadottak szerint paramétereket.

Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.

Paraméterek

(object) A kívánt kimenetet meghatározó paraméterek.

A módszer a következő paramétereket támogatja.

Paraméter	Típus	Leírás
reportids	string/array	Csak ütemezett jelentéseket ad vissza a megadott jelentésazonosítókkal.
expired	boolean	Ha `true`-ra van állítva, akkor csak lejárt ütemezett jelentéseket ad vissza, ha `false` - csak aktív ütemezett jelentéseket.
selectUsers	query	Egy users tulajdonság visszaadása a jelentés küldésére van beállítva.
selectUserGroups	query	Egy user_groups tulajdonság visszaadása a jelentés küldésére van beállítva.
sortfield	string/array	Rendezd az eredményt a megadott tulajdonságok szerint. A lehetséges értékek: `reportid`, `name`, `status`.
countOutput	boolean	Ezek a paraméterek, amelyek minden `get` metódusnál közösek, a referenciakommentár oldalon találhatók.
excludeSearch	logikai
szűrő	objektum
korlát	egész szám
kimenet	lekérdezés
preservekeys	boolean
kereső	objektum
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	karakterlánc/tömb
startSearch	boolean

Visszatérési értékek

(integer/array) A következőket adja vissza:

objektumok tömbje;
a letöltött objektumok száma, ha a countOutput paraméter használva volt.

Példák

Retrieving report data

Request:

{
           "jsonrpc": "2.0",
           "method": "report.get",
           "params": [
               "output": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "reportids": ["1", "2"]
           ],
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "reportid": "1",
                   "userid": "1",
                   "name": "Weekly report",
                   "dashboardid": "1",
                   "period": "1",
                   "cycle": "1",
                   "start_time": "43200",
                   "weekdays": "31",
                   "active_since": "2021-04-01",
                   "active_till": "2021-08-31",
                   "subject": "Weekly report",
                   "message": "Report accompanying text",
                   "status": "1",
                   "description": "Report description",
                   "state": "1",
                   "lastsent": "1613563219",
                   "info": "",
                   "users": [
                       {
                           "userid": "1",
                           "access_userid": "1",
                           "exclude": "0"
                       },
                       {
                           "userid": "2",
                           "access_userid": "0",
                           "exclude": "1"
                       }
                   ],
                   "user_groups": [
                       {
                           "usrgrpid": "7",
                           "access_userid": "0"
                       }
                   ]
               },
               {
                   "reportid": "2",
                   "userid": "1",
                   "name": "Monthly report",
                   "dashboardid": "2",
                   "period": "2",
                   "cycle": "2",
                   "start_time": "0",
                   "weekdays": "0",
                   "active_since": "2021-05-01",
                   "active_till": "",
                   "subject": "Monthly report",
                   "message": "Report accompanying text",
                   "status": "1",
                   "description": "",
                   "state": "0",
                   "lastsent": "0",
                   "info": "",
                   "users": [
                       {
                           "userid": "1",
                           "access_userid": "1",
                           "exclude": "0"
                       }
                   ],
                   "user_groups": []
               }
           ],
           "id": 1
       }

Lásd még

Forrás

CReport::get() az ui/include/classes/api/services/CReport.php-ban.

Documentation