report.get

Опис

integer/array report.get(object parameters)

Метода омогућава преузимање заказаних извештаја према датим параметрима.

Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Улоге корисника за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter	Type	Description
reportids	ID/array	Враћа само планиране извештаје са датим ID-ијевима извештаја.
expired	boolean	Ако је подешено на `true` враћа само истекле планиране извештаје, ако је `false` - само активне заказане извештаје.
selectUsers	query	Враћа својство `users` са корисницима којима је извештај конфигурисан да се пошаље.
selectUserGroups	query	Враћа `user_groups` својство са групама корисника којима је извештај конфигурисан да се пошаље.
sortfield	string/array	Сортира резултат према датим својствима. Могуће вредности: `reportid`, `name`, `status`.
countOutput	boolean	Ови параметри су описани у референтном коментару.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Повратне вредности

(integer/array) Враћа било:

низ објеката;
број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање података из извештаја

Захтев:

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

Одговор:

{
            "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
       }

Такође погледајте

Извор

CReport::get() in ui/include/classes/api/services/CReport.php.

Documentation