[comment]: # ({7925fa72-7925fa72})
# report.get

[comment]: # ({/7925fa72-7925fa72})

[comment]: # ({c4ffda2f-22ec64b6})
### Opis

`integer/array report.get(object parameters)`

Ta metoda umożliwia pobieranie zaplanowanych raportów zgodnie z podanymi
parametrami.

::: noteclassic
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia
do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w [Rolach
użytkowników](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/c4ffda2f-22ec64b6})

[comment]: # ({9bbdf58d-2bc4ba55})
### Parametry

`(object)` Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

|Parametr|[Typ](/manual/api/reference_commentary#data-types)|Opis|
|--|--|------|
|reportids|ID/array|Zwraca tylko zaplanowane raporty o podanych identyfikatorach raportów.|
|expired|boolean|Jeśli ustawiono na `true`, zwraca tylko wygasłe zaplanowane raporty.|
|selectUsers|query|Zwraca właściwość [`users`](/manual/api/reference/report/object#users) zawierającą użytkowników, do których skonfigurowano wysyłanie raportu.|
|selectUserGroups|query|Zwraca właściwość [`user_groups`](/manual/api/reference/report/object#user-groups) zawierającą grupy użytkowników, do których skonfigurowano wysyłanie raportu.|
|sortfield|string/array|Sortuje wynik według podanych właściwości.<br><br>Możliwe wartości: `reportid`, `name`, `status`.|
|countOutput|boolean|Te parametry opisano w [komentarzu referencyjnym](/manual/api/reference_commentary#common-get-method-parameters).|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/9bbdf58d-2bc4ba55})

[comment]: # ({7223bab1-7223bab1})
### Zwracane wartości

`(integer/array)` Zwraca:

-   tablicę obiektów;
-   liczbę pobranych obiektów, jeśli został użyty parametr `countOutput`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Przykłady

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({65ef8cf5-b7379080})
#### Pobieranie danych raportu

[Żądanie](/manual/api#performing-requests):

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

Odpowiedź:

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

[comment]: # ({/65ef8cf5-b7379080})

[comment]: # ({7dcda109-7b8422b2})
### Zobacz także

-   [Użytkownicy](/manual/api/reference/user/object#users)
-   [Grupy użytkowników](/manual/api/reference/user/object#user-groups)

[comment]: # ({/7dcda109-7b8422b2})

[comment]: # ({de82795f-de82795f})
### Źródło

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

[comment]: # ({/de82795f-de82795f})