iconmap.create

説明

object iconmap.create(object/array iconMaps)

このメソッドは新しいアイコンマップを作成します。

このメソッドはスーパ管理者ユーザータイプでのみ利用可能です。 このメソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object/array) 作成するアイコンマップ。

標準のアイコンマッププロパティに加えて、このメソッドは以下のパラメータを受け付けます。

パラメータ タイプ 説明
mappings array アイコンマップに作成するアイコンマッピング

パラメータの動作:
- 必須

戻り値

(object) iconmapidsプロパティの下で作成されたアイコンマップのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたアイコンマップの順序と一致します。

アイコンマップの作成

異なるタイプのホストを表示するためのアイコンマップを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "iconmap.create",
    "params": {
        "name": "Type icons",
        "default_iconid": "2",
        "mappings": [
            {
                "inventory_link": 1,
                "expression": "server",
                "iconid": "3"
            },
            {
                "inventory_link": 1,
                "expression": "switch",
                "iconid": "4"
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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