report.delete

Description

object report.delete(array reportids)

This method allows to delete 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

(array) IDs of the scheduled reports to delete.

Return values

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

Examples

Deleting multiple scheduled reports

Delete two scheduled reports.

Request:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "report.delete",
  4. "params": [
  5. "1",
  6. "2"
  7. ],
  8. "id": 1
  9. }

Response:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": {
  4. "reportids": [
  5. "1",
  6. "2"
  7. ]
  8. },
  9. "id": 1
  10. }

Source

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