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

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

[comment]: # ({c4ffda2f-22ec64b6})
### Описание

`integer/array report.get(параметры объекта)`

Метод позволяет получать запланированные отчеты по заданным параметрам.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({9bbdf58d-2bc4ba55})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|reportids|ID/array|Возвращать только запланированные отчеты с указанными ID отчетов.|
|expired|boolean|Если установлено значение `true`, возвращать только просроченные запланированные отчеты.|
|selectUsers|query|Возвращать свойство [`users`](/manual/api/reference/report/object#users) с пользователями, которым настроена отправка отчета.|
|selectUserGroups|query|Возвращать свойство [`user_groups`](/manual/api/reference/report/object#user-groups) с группами пользователей, которым настроена отправка отчета.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `reportid`, `name`, `status`.|
|countOutput|boolean|Эти параметры описаны в [reference commentary](/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})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Примеры

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

[comment]: # ({65ef8cf5-b7379080})
#### Получение данных отчета

[Запрос](/manual/api#performing-requests):

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

Ответ:

```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})
### См. также

-   [Пользователи](/manual/api/reference/user/object#users)
-   [Группы пользователей](/manual/api/reference/user/object#user-groups)

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

[comment]: # ({de82795f-de82795f})
### Источник

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

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