history.clear

説明

object history.clear(array itemids)

このメソッドを使用すると、アイテムの履歴を削除できます。

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

パラメーター

(array) ヒストリを消去するアイテムのID。

戻り値

(object) itemidsプロパティの下にあるヒストリが消去されたアイテムのIDを含むオブジェクトを返します。

例

ヒストリの消去

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "history.clear",
    "params": [
        "10325",
        "13205"
    ],
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "itemids": [
            "10325",
            "13205"
        ]
    },
    "id": 1
}

ソース

CHistory::clear() in ui/include/classes/api/services/CHistory.php.