valuemap.update
説明
object valuemap.update(object/array valuemaps)
このメソッドでは既存のバリューマップを更新できます。
このメソッドはSuperadminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object/array) バリューマップのプロパティ が更新されます。
valuemapidプロパティは、バリューマップごとに設定する必要があります。すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。
戻り値
(object) valuemapidsプロパティの下にある更新されたバリューマップのIDを含むオブジェクトを返します。
例
バリューマップ名の変更
バリューマップの名前を"Device status"に変更する
Request:
{
"jsonrpc": "2.0",
"method": "valuemap.update",
"params": {
"valuemapid": "2",
"name": "Device status"
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"2"
]
},
"id": 1
}1つのバリューマップのマッピングを変更します。
Request:
{
"jsonrpc": "2.0",
"method": "valuemap.update",
"params": {
"valuemapid": "2",
"mappings": [
{
"type": "0",
"value": "0",
"newvalue": "Online"
},
{
"type": "0",
"value": "1",
"newvalue": "Offline"
}
]
},
"auth": "57562fd409b3b3b9a4d916d45207bbcb",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"valuemapids": [
"2"
]
},
"id": 1
}ソース
CValueMap::update() in ui/include/classes/api/services/CValueMap.php.