valuemap.get

Description

integer/array valuemap.get(object parameters)

The method allows to retrieve value maps according to the given parameters.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
valuemapids string/array Return only value maps with the given IDs.
selectMappings query Return the value mappings for current value map in the mappings property.

Supports count.
sortfield string/array Sort the result by the given properties.

Possible values: valuemapid, name.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieving value maps

Retrieve all configured value maps.

Request:

{
           "jsonrpc": "2.0",
           "method": "valuemap.get",
           "params": {
               "output": "extend"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "valuemapid": "4",
                   "name": "APC Battery Replacement Status"
               },
               {
                   "valuemapid": "5",
                   "name": "APC Battery Status"
               },
               {
                   "valuemapid": "7",
                   "name": "Dell Open Manage System Status"
               }
           ],
           "id": 1
       }

Retrieve one value map with its mappings.

Request:

{
           "jsonrpc": "2.0",
           "method": "valuemap.get",
           "params": {
               "output": "extend",
               "selectMappings": "extend",
               "valuemapids": ["4"]
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "valuemapid": "4",
                   "name": "APC Battery Replacement Status",
                   "mappings": [
                       {
                           "type": "0",
                           "value": "1",
                           "newvalue": "unknown"
                       },
                       {
                           "type": "0",
                           "value": "2",
                           "newvalue": "notInstalled"
                       },
                       {
                           "type": "0",
                           "value": "3",
                           "newvalue": "ok"
                       },
                       {
                           "type": "0",
                           "value": "4",
                           "newvalue": "failed"
                       },
                       {
                           "type": "0",
                           "value": "5",
                           "newvalue": "highTemperature"
                       },
                       {
                           "type": "0",
                           "value": "6",
                           "newvalue": "replaceImmediately"
                       },
                       {
                           "type": "0",
                           "value": "7",
                           "newvalue": "lowCapacity"
                       }
                   ]
               }
           ],
           "id": 1
       }

Source

CValueMap::get() in ui/include/classes/api/services/CValueMap.php.