image.getobjects

Description

array image.getobjects(object filter)

This method allows to retrieve images that match the given filter criteria.

This method is deprecated and will be removed in the future. Please use image.get instead.

Parameters

(object) Image properties to search by.

Return values

(array) Returns an array of objects with all properties.

Examples

Retrieve image by name

Retrieve image called "Cloud_(24)".

Request:

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

Response:

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

Source

CImage::getObject() in frontends/php/include/classes/api/services/CImage.php.

Documentation