image.getobjects

Описание

массив image.getobjects(объект фильтр)

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

Параметры

(объект) Критерий по которому производить поиск.

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

Параметр Тип Описание
node строка Имя ноды, которой должны принадлежать изображения.

Этот параметр переписывает параметр nodeids.
nodeids строка/массив ID нод, которой должны принадлежать изображения.

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

(массив) Возвращает массив объектов со всеми свойствами.

Примеры

Получение изображения по имени

Получение изображения с именем "Cloud_(24)".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "image.getobjects",
    "params": {
        "name": "Cloud_(24)"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "imageid": "2",
            "imagetype": "1",
            "name": "Cloud_(24)"
        }
    ],
    "id": 1
}

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

Исходный код

CImage::getObject() в frontends/php/api/classes/CImage.php.