templatedashboard.delete

Description

object templatedashboard.delete(array templateDashboardIds)

This method allows to delete template dashboards.

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 the template dashboards to delete.

Return values

(object) Returns an object containing the IDs of the deleted template dashboards under the dashboardids property.

Examples

Deleting multiple template dashboards

Delete two template dashboards.

Request:

{
           "jsonrpc": "2.0",
           "method": "templatedashboard.delete",
           "params": [
               "45",
               "46"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "45",
                   "46"
               ]
           },
           "id": 1
       }

Source

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

Documentation