Identifier ID Import¶
POST /api/v1/board/import/identifier
Overview¶
Global import based on identifier ID
Body Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| importType | array | Y | Import coverage scope, dashboard-Dashboard; userViewer-User Viewer; innerViewerZh-Chinese Built-in Viewer; innerViewerEn-English Built-in Viewer Allow empty: False |
| identifier | string | Y | Identifier ID Allow empty: False |
| templateInfo | json | Dashboard template data Example: {} Allow empty: False Allow empty string: False |
Additional Parameter Explanation¶
Parameter explanation: | Parameter Name | type | Required | Description | |-----------------------|----------|----|------------------------| |importType |array[string] | Must | Import coverage scope, dashboard-Dashboard; userViewer-User Viewer; innerViewerZh-Chinese Built-in Viewer; innerViewerEn-English Built-in Viewer | |identifier |string | | Identifier ID | |templateInfo |json | | Dashboard template data |
templateInfo Main Structure Explanation
Note that if the following fields are passed in, all object corresponding fields with the same identifier ID will be replaced. If not passed in, no replacement will occur, and the original object attribute values will be used
| Parameter Name | type | Required | Description |
|---|---|---|---|
| title | string | Viewer title name, note that if this field is passed in, it will replace all object attributes with the same identifier ID | |
| summary | string | Template summary information, note that if this field is passed in, it will replace all object attributes with the same identifier ID | |
| identifier | string | Template identifier ID, note that if this field is passed in, it will replace all object titles with the same identifier ID | |
| dashboardExtend | json | Viewer extra data information | |
| dashboardMapping | array[json] | List of field mapping configurations for viewer variables | |
| iconSet | json | Dashboard icon information, note that if this field is passed in, it will replace all object titles with the same identifier ID | |
| iconSet.url | json | Medium icon link address for the dashboard | |
| iconSet.icon | json | Small icon link address for the dashboard | |
| icon | string | Small icon filename for the dashboard, note that if this field is passed in, it will replace all object titles with the same identifier ID | |
| thumbnail | string | Medium icon filename for the dashboard, note that if this field is passed in, it will replace all object titles with the same identifier ID | |
| main | json | Dashboard content structure | |
| main.type | string | Template type, this field is a system field and can be ignored | |
| main.vars | array[json] | Viewer variable configuration list | |
| main.vars[#] | json | Viewer variable configuration structure | |
| main.groups | array[string] | Chart group name list | |
| main.charts | array[json] | Viewer chart configuration list | |
| main.charts[#] | json | Chart configuration structure |
dashboardMapping[#] Main Structure Explanation
| Parameter Name | type | Required | Description |
|---|---|---|---|
main.charts[#] Main Structure Explanation
| Parameter Name | type | Required | Description |
|---|---|---|---|
| name | string | Must | Chart name |
| type | string | Must | Chart type |
| pos | json | Chart position structure | |
| pos.i | string | ||
| pos.h | string | Height | |
| pos.w | string | Width | |
| pos.x | string | X-axis coordinate | |
| pos.y | string | Y-axis coordinate | |
| group | json[string] | Group information | |
| group.name | string | Group name, allowed to be null if there is no group | |
| queries | array[json] | Must | Chart query statement structure list |
**Time Series Chart Structure main.charts[#].type=sequence Its main structure parameters are as follows: **
| Parameter Name | type | Required | Description |
|---|---|---|---|
| name | string | Must | Chart name |
| type | string | Must | Chart type |
| pos | string | Must | Chart type |
| queries | array[json] | Must | Chart query statement structure list |