标识ID导入¶
POST /api/v1/board/import/identifier
概述¶
根据标识ID全局导入
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| importType | array | Y | 导入覆盖范围,dashboard-仪表板；userViewer-用户视图；innerViewerZh-中文内置视图；innerViewerEn-英文内置视图 允许为空: False |
| identifier | string | Y | 标识ID 允许为空: False |
| templateInfo | json | 仪表板模板数据 例子: {} 允许为空: False 允许空字符串: False |
参数补充说明¶
参数说明: | 参数名 | type | 必选 | 说明 | |-----------------------|----------|----|------------------------| |importType |array[string] | 必须 | 导入覆盖范围,dashboard-仪表板；userViewer-用户视图；innerViewerZh-中文内置视图；innerViewerEn-英文内置视图 | |identifier |string | | 标识ID | |templateInfo |json | | 仪表板模板数据 |
templateInfo的主体结构说明
注意以下字段如果传入则会将所有标识ID一致的对象对应字段进行替换，如果不传入则不进行替换，使用原有对象的属性值
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
| title | string | 视图标题名称，注意如果传入该字段则会将所有标识ID一致的对象属性替换 | |
| summary | string | 模板的摘要信息，注意如果传入该字段则会将所有标识ID一致的对象属性替换 | |
| identifier | string | 模版标识id，注意如果传入该字段则会将所有标识ID一致的对象标题替换 | |
| dashboardExtend | json | 视图额外数据信息 | |
| dashboardMapping | array[json] | 视图变量的字段映射配置列表 | |
| iconSet | json | 仪表版图标信息，注意如果传入该字段则会将所有标识ID一致的对象标题替换 | |
| iconSet.url | json | 仪表版中等图标链接地址 | |
| iconSet.icon | json | 仪表版小图标链接地址 | |
| icon | string | 仪表版小图标文件名，注意如果传入该字段则会将所有标识ID一致的对象标题替换 | |
| thumbnail | string | 仪表版中等图标文件名，注意如果传入该字段则会将所有标识ID一致的对象标题替换 | |
| main | json | 仪表板内容结构 | |
| main.type | string | 模板类型, 该字段为系统字段，可忽略 | |
| main.vars | array[json] | 视图变量配置列表 | |
| main.vars[#] | json | 视图变量配置结构 | |
| main.groups | array[string] | 图表分组名列表 | |
| main.charts | array[json] | 视图的图表配置列表 | |
| main.charts[#] | json | 图表配置结构 |
dashboardMapping[#]的主体结构说明
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
main.charts[#]的主体结构说明
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
| name | string | 必须 | 图表名字 |
| type | string | 必须 | 图表类型 |
| pos | json | 图表的位置结构 | |
| pos.i | string | ||
| pos.h | string | 高度 | |
| pos.w | string | 宽度 | |
| pos.x | string | x轴坐标 | |
| pos.y | string | y轴坐标 | |
| group | json[string] | 分组信息 | |
| group.name | string | 分组名, 没有分组是允许为 null | |
| queries | array[json] | 必须 | 图表查询查询语句结构列表 |
**时序图表 结构 main.charts[#].type=sequence 其主体结构参数如下: **
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
| name | string | 必须 | 图表名字 |
| type | string | 必须 | 图表类型 |
| pos | string | 必须 | 图表类型 |
| queries | array[json] | 必须 | 图表查询查询语句结构列表 |