Table of Contents
get()
Available since version: 1.8
This function allows you to retrieve image details based on filtering options. All parameters are optional. If parameter is set in query this option counted as ON, except if parameter is equal to NULL.
Parameters
| Parameter | Type | Description | Details |
|---|---|---|---|
| nodeids | array | Node IDs | |
| imageids | array | Image IDs | |
| sysmapids | array | Map IDs | |
| editable | integer | only with read-write permission. Ignored for SuperAdmins | |
| filter | array | Optional filter by image fields | |
| search | array | Return images by any given image object field pattern | |
| startSearch | integer | Search images field pattern only in start of the field | |
| excludeSearch | integer | Exclude from result, images by given field pattern | |
| searchWildcardsEnabled | integer | Search pattern in whole field using wildcards | 1 - enable, 0 - disable |
| output | string | Output options | Values: shorten, refer, extend |
| select_image | string | Select image source | |
| countOutput | integer | Count images, return the number of images found | |
| preservekeys | integer | Return hash instead of array | Keys of hash are object IDs |
| sortfield | string | Sort by image field | Values: imageid, name |
| sortorder | string | Sort order | Values: ASC, DESC |
| limit | int | max number of image objects to return | |
Returns
| Parameter | Description |
|---|---|
| result | Operation successful. Result will contain array of Image objects. |
| error | In case of any errors |
Example
Get images details by image description "Hub" and "UPS", return only image details, without image source:
{
"jsonrpc":"2.0",
"method":"image.get",
"params":{
"filter": {"name": ["Hub", "UPS"]},
"output": "extend"
},
"auth":"6f38cddc44cfbb6c1bd186f9a220b5a0",
"id":2
}Retrieved images details: