report.update

Description

object report.update(object/array reports)

This method allows to update existing scheduled reports.

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

Parameters

(object/array) Scheduled report properties to be updated.

The reportid property must be defined for each scheduled report, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard scheduled report properties the method accepts the following parameters.

Parameter	Type	Description
users	object/array	Users to replace the current users assigned to the scheduled report. Parameter behavior: - required if `user_groups` is not set
user_groups	object/array	User groups to replace the current user groups assigned to the scheduled report. Parameter behavior: - required if `users` is not set

Return values

(object) Returns an object containing the IDs of the updated scheduled reports under the reportids property.

Examples

Disabling scheduled report

Request:

{
           "jsonrpc": "2.0",
           "method": "report.update",
           "params": {
               "reportid": "1",
               "status": "0"
           },
           "id": 1
       }

Response:

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

Source

CReport::update() in ui/include/classes/api/services/CReport.php.

Documentation