iconmap.delete

説明

object iconmap.delete(array iconMapIds)

このメソッドは、アイコンマップを削除することができます。

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

パラメーター

(array) 削除するアイコンマップのID。

戻り値

(object) iconmapidsプロパティの下にある削除されたアイコンマップのIDを含むオブジェクトを返します。

例

複数のアイコンマップの削除

2つのアイコンマップを削除します。

リクエスト:

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

レスポンス:

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

ソース

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