hostprototype.delete

説明

object hostprototype.delete(array hostPrototypeIds)

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

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

パラメーター

(array) 削除するホストのプロトタイプのID。

戻り値

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

例

複数のホストのプロトタイプの削除

2つのホストのプロトタイプを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostprototype.delete",
    "params": [
        "10103",
        "10105"
    ],
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10103",
            "10105"
        ]
    },
    "id": 1
}

ソース

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