valuemap.get

Beschrijving

integer/array valuemap.get(object parameters)

Deze methode maakt het mogelijk om waardeafbeeldingen op te halen volgens de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode op te roepen kunnen worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste output definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
valuemapids string/array Geef alleen waardeafbeeldingen terug met de opgegeven ID's.
selectMappings query Geef de waardeafbeeldingen voor de huidige waardeafbeelding terug in de mappings eigenschap.

Ondersteunt count.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: valuemapid, name.
countOutput boolean Deze parameters die gemeenschappelijk zijn voor alle get methoden worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Waardeafbeeldingen ophalen

Haal alle geconfigureerde waardeafbeeldingen op.

Aanvraag:

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

Reactie:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "valuemapid": "4",
            "name": "APC Batterijvervangingsstatus"
        },
        {
            "valuemapid": "5",
            "name": "APC Batterijstatus"
        },
        {
            "valuemapid": "7",
            "name": "Dell Open Manage Systeemstatus"
        }
    ],
    "id": 1
}

Haal één waardeafbeelding op met de bijbehorende afbeeldingen.

Aanvraag:

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

Reactie:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "valuemapid": "4",
            "name": "APC Batterijvervangingsstatus",
            "mappings": [
                {
                    "type": "0",
                    "value": "1",
                    "newvalue": "onbekend"
                },
                {
                    "type": "0",
                    "value": "2",
                    "newvalue": "nietGeïnstalleerd"
                },
                {
                    "type": "0",
                    "value": "3",
                    "newvalue": "ok"
                },
                {
                    "type": "0",
                    "value": "4",
                    "newvalue": "mislukt"
                },
                {
                    "type": "0",
                    "value": "5",
                    "newvalue": "hogeTemperatuur"
                },
                {
                    "type": "0",
                    "value": "6",
                    "newvalue": "onmiddellijkVervangen"
                },
                {
                    "type": "0",
                    "value": "7",
                    "newvalue": "lageCapaciteit"
                }
            ]
        }
    ],
    "id": 1
}

Bron

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