valuemap.get

説明

integer/array valuemap.get(object parameters)

このメソッドでは、指定されたパラメーターに従ってバリューマップを取得できます。

このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。

パラメータ

(object) 目的の出力を定義するパラメーター。

このメソッドは、次のパラメーターをサポートします。

パラメータ	タイプ	説明
valuemapids	string/array	指定されたIDを持つバリューマップのみを返します
selectMappings	query	mappingsプロパティで現在のバリューマップのバリューマッピングを返します。 `count`をサポートします。
sortfield	string/array	指定されたプロパティで結果を並べ替えます。可能な値は`valuemapid`と`name`です。
countOutput	boolean	すべての`get`メソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

戻り値

(integer/array) 次のいずれかを返します:

オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数

例

バリューマップの取得

構成済みのすべてのバリューマップを取得します。

Request:

{
           "jsonrpc": "2.0",
           "method": "valuemap.get",
           "params": {
               "output": "extend"
           },
           "auth": "57562fd409b3b3b9a4d916d45207bbcb",
           "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"]
           },
           "auth": "57562fd409b3b3b9a4d916d45207bbcb",
           "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
       }

ソース

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

Documentation

valuemap.get

説明

パラメータ

戻り値

例

バリューマップの取得

ソース