usermacro.delete

説明

object usermacro.delete(array hostMacroIds)

このメソッドは、ホストマクロを削除することができます。

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

パラメーター

(array) 削除するホストマクロのID。

戻り値

(object) hostmacroidsプロパティの下にある削除されたホストマクロのIDを含むオブジェクトを返します。

例

複数のホストマクロの削除

2つのホストマクロを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "usermacro.delete",
    "params": [
        "32",
        "11"
    ],
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "hostmacroids": [
            "32",
            "11"
        ]
    },
    "id": 1
}

ソース

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