Esta es una traducción de la página de documentación original en español. Ayúdanos a mejorarla.

valuemap.get

Descripción

integer/array valuemap.get(object parameters)

El método permite recuperar mapas de valores según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
valuemapids ID/array Devuelve solo mapas de valores con los ID proporcionados.
selectMappings query Devuelve las asignaciones de valores para el mapa de valores actual en la propiedad mappings.

Admite count.
sortfield string/array Ordena el resultado según las propiedades dadas.

Valores posibles: valuemapid, name.
countOutput boolean Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia.
editable booleano
excluirBuscar booleano
filtro objeto
límite entero
salida consulta
preservekeys booleano
buscar objeto
searchByAny booleano
searchWildcardsEnabled booleano
clasificación cadena/matriz
iniciarBuscar booleano

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando mapas de valores

Recupera todos los mapas de valores configurados.

Solicitud:

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

Respuesta:

{
           "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
       }

Recupera un mapa de valores con sus asignaciones.

Consulta:

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

Respuesta:

{
           "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
       }

Fuente

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