valuemap.update

説明

object valuemap.update(object/array valuemaps)

このメソッドでは、既存の値マップを更新できます。

パラメータ

(object/array) 更新する値マップのプロパティ。

各値マップでは valuemapid プロパティを定義する必要があり、その他の プロパティはすべて任意です。渡されたプロパティのみが更新され、それ以外は 変更されません。

戻り値

(object) valuemapidsプロパティの下にある更新されたバリューマップのIDを含むオブジェクトを返します。

例

値マップ名の変更

値マップ名を「Device status」に変更します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "valuemap.update",
    "params": {
        "valuemapid": "2",
        "name": "Device status"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "valuemapids": [
            "2"
        ]
    },
    "id": 1
}

1つの値マップのマッピングを変更する

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "valuemap.update",
    "params": {
        "valuemapid": "2",
        "mappings": [
            {
                "type": "0",
                "value": "0",
                "newvalue": "Online"
            },
            {
                "type": "0",
                "value": "1",
                "newvalue": "Offline"
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "valuemapids": [
            "2"
        ]
    },
    "id": 1
}

ソース

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