report.update

Описание

object report.update(объект/массив reports)

Этот метод позволяет обновлять существующие запланированные отчеты.

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

Параметры

(object/array) Свойства запланированного отчета, которые необходимо обновить.

Свойство reportid должно быть определено для каждого запланированного отчета, все остальные свойства являются необязательными. Будут обновлены только переданные свойства, все остальные останутся без изменений.

В дополнение к стандартным свойствам запланированного отчета метод принимает следующие параметры.

Параметр Тип Описание
users object/array Пользователи для замены текущих пользователей, назначенных запланированному отчету.

Поведение параметра:
- обязательно, если user_groups не задан
user_groups object/array Группы пользователей для замены текущих групп пользователей, назначенных запланированному отчету.

Поведение параметра:
- обязательно, если users не задан

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

(object) Возвращает объект, содержащий идентификаторы обновлённых запланированных отчётов в свойстве reportids.

Примеры

Отключение запланированного отчета

Запрос:

{
    "jsonrpc": "2.0",
    "method": "report.update",
    "params": {
        "reportid": "1",
        "status": "0"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "reportids": [
            "1"
        ]
    },
    "id": 1
}

См. также

Источник

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