report.get

Apraksts

integer/array report.get(object parameters)

Metode ļauj izgūt ieplānotos pārskatus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
reportids ID/array Atgriezt tikai ieplānotos pārskatus ar norādītajiem pārskatu ID.
expired boolean Ja iestatīts uz true, atgriezt tikai ieplānotos pārskatus, kuriem ir beidzies derīguma termiņš.
selectUsers query Atgriezt users īpašību ar lietotājiem, kuriem ir konfigurēta pārskata nosūtīšana.
selectUserGroups query Atgriezt user_groups īpašību ar lietotāju grupām, kurām ir konfigurēta pārskata nosūtīšana.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: reportid, name, status.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Pārskata datu izgūšana

Pieprasījums:

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

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "reportid": "1",
            "userid": "1",
            "name": "Nedēļas pārskats",
            "dashboardid": "1",
            "period": "1",
            "cycle": "1",
            "start_time": "43200",
            "weekdays": "31",
            "active_since": "2021-04-01",
            "active_till": "2021-08-31",
            "subject": "Nedēļas pārskats",
            "message": "Pārskatam pievienotais teksts",
            "status": "1",
            "description": "Pārskata apraksts",
            "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": "Mēneša pārskats",
            "dashboardid": "2",
            "period": "2",
            "cycle": "2",
            "start_time": "0",
            "weekdays": "0",
            "active_since": "2021-05-01",
            "active_till": "",
            "subject": "Mēneša pārskats",
            "message": "Pārskatam pievienotais teksts",
            "status": "1",
            "description": "",
            "state": "0",
            "lastsent": "0",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                }
            ],
            "user_groups": []
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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