Documentation
Table of Contents
iconmap.update
説明
object iconmap.update(object/array iconMaps)
このメソッドをでは既存のアイコンマップを更新できます。
このメソッドはSuperadminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object/array) 更新されるアイコンマップのプロパティ
iconmapidプロパティはアイコンマップごとに定義する必要があり、すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。
標準のアイコンマッププロパティに加えて、このメソッドは次のパラメーターを受け入れます。
戻り値
(object) iconmapidsプロパティの下にある更新されたアイコンマップのIDを含むオブジェクトを返します
例
アイコンマップの名前変更
アイコンマップの名前を"OSアイコン"に変更します。
Request:
{
"jsonrpc": "2.0",
"method": "iconmap.update",
"params": {
"iconmapid": "1",
"name": "OS icons"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
参照
ソース
CIconMap::update() in ui/include/classes/api/services/CIconMap.php.