history.clear

Description

object history.clear(array itemids)

This method allows to clear item history.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of items to clear.

Return values

(object) Returns an object containing the IDs of the cleared items under the itemids property.

Examples

Clear history

Request:

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

Response:

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

Source

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

Documentation