这是原厂英文文档的翻译页面. 欢迎帮助我们 完善文档.

创建模板仪表盘

描述

object templatedashboard.create(object/array templateDashboards)

此方法允许创建新的模板仪表板。

此方法仅适用于管理员超级管理员用户类型。可以在用户角色设置中撤销调用该方法的权限。 详情查阅 用户角色

参数

(object/array) 要创建的模板仪表盘。

除了 标准模板仪表盘属性外,该方法还接受以下参数。

参数 类型 描述
pages
(必须)
array 要为仪表盘创建的模板仪表盘页面。仪表盘页面按指定的顺序排序。pages属性至少需要一个仪表盘页面对象。

返回值

(object) 返回一个对象,该对象包含dashboardids 属性下创建的模板仪表盘的ID。返回ID的顺序与传递的模板仪表盘的顺序匹配。

示例

创建一个模版仪表盘

在单个仪表盘页面上使用一个Graph组件创建一个名为“Graphs”的模板仪表盘。

请求:

{
           "jsonrpc": "2.0",
           "method": "templatedashboard.create",
           "params": {
               "templateid": "10318",
               "name": "Graphs",
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "graph",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 6,
                                       "name": "graphid",
                                       "value": "1123"
                                   }
                               ]
                           }
                       ]
                       
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

参阅

源码

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