image.update

Описание

объект image.update(объект/массив изображения)

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

Параметры

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

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

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

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

Исходный код

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