action.update

Описание

объект action.update(объект/массив действий)

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

Параметры

(объект/массив) Свойства действия, которые будут обновлены.

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

В дополнение к стандартным свойствам действия, этот метод принимает следующие параметры.

Параметр Тип Описание
filter объект Объект фильтра действия, который заменит текущий фильтр.
operations массив Операции действия, которые заменят существующие операции.
recovery_operations массив Операции о восстановления действия, которые заменят текущие операции о восстановлении.
acknowledge_operations массив Операции о подтверждении действия, которые заменят текущие операции о подтверждении.

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

(объект) Возвращает объект, который содержит ID обновленных действий под свойством actionids.

Примеры

Деактивация действия

Деактивация действия, то есть, изменение состояния на значение равное "1".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "action.update",
    "params": {
        "actionid": "2",
        "status": "1"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

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

Смотрите также

Исходный код

CAction::update() в frontends/php/include/classes/api/services/CAction.php.