valuemap.delete

説明

object valuemap.delete(array valuemapids)

このメソッドを使用すると、値マップを削除できます。

このメソッドは、Super admin ユーザータイプでのみ利用できます。 このメソッドの呼び出し権限は、ユーザー権限設定で取り消すことができます。詳細は User roles を参照してください。

パラメーター

(array) 削除するバリューマップのID。

戻り値

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

例

複数のバリューマップの削除

2つのバリューマップを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "valuemap.delete",
    "params": [
        "1",
        "2"
    ],
    "id": 1
}

レスポンス:

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

ソース

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