iconmap.create

説明

object iconmap.create(object/array iconMaps)

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

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

パラメータ

(object/array) アイコンマップの作成

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

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

戻り値

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

アイコンマップを作成する

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

Request:

{
    "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"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

参照

ソース

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