report.get

Описание

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

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
reportids ID/array Возвращать только запланированные отчёты с указанными ID отчётов.
expired boolean Если установлено значение true, возвращать только просроченные запланированные отчёты.
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

Возвращаемые значения

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

  • · массив объектов;
  • · количество извлеченных объектов, если использовался параметр 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": "Еженедельный отчёт",
            "dashboardid": "1",
            "period": "1",
            "cycle": "1",
            "start_time": "43200",
            "weekdays": "31",
            "active_since": "2021-04-01",
            "active_till": "2021-08-31",
            "subject": "Еженедельный отчёт",
            "message": "Сопроводительный текст отчёта",
            "status": "1",
            "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": "Ежемесячный отчёт",
            "dashboardid": "2",
            "period": "2",
            "cycle": "2",
            "start_time": "0",
            "weekdays": "0",
            "active_since": "2021-05-01",
            "active_till": "",
            "subject": "Ежемесячный отчёт",
            "message": "Сопроводительный текст отчёта",
            "status": "1",
            "description": "",
            "state": "0",
            "lastsent": "0",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                }
            ],
            "user_groups": []
        }
    ],
    "id": 1
}

См. также

Источник

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