image.update

Описание

object image.update(object/array images)

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

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

Параметры

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

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

Метод принимает изображения со стандартными свойствами изображения.

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

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

Примеры

Переименовать изображение

Переименуйте изображение в "Cloud icon".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "image.update",
    "params": {
        "imageid": "2",
        "name": "Cloud icon"
    },
    "id": 1
}

Ответ:

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

Источник

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