Identifier Import¶
POST /api/v1/board/import/identifier
Overview¶
Global import based on identifier ID
Body Request Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| importType | array | Y | Import coverage, dashboard-dashboard; userViewer-user view; innerViewerZh-Chinese built-in view; innerViewerEn-English built-in view Allow empty: False |
| identifier | string | Y | Identifier ID Allow empty: False |
| templateInfo | json | Dashboard template data Example: {} Allow empty: False Allow empty string: False |
Parameter Supplementary Explanation¶
Parameter explanation:
| Parameter | Type | Required | Description |
|---|---|---|---|
| importType | array[string] | Required | Import coverage, dashboard-dashboard; userViewer-user view; innerViewerZh-Chinese built-in view; innerViewerEn-English built-in view |
| identifier | string | Identifier ID | |
| templateInfo | json | Dashboard template data |
templateInfo Main Structure Explanation
Note: If the following fields are passed, they will replace the corresponding fields of all objects with the same identifier ID. If not passed, the original object's property values will be used.
| Parameter | Type | Required | Description |
|---|---|---|---|
| title | string | View title name. Note: If this field is passed, it will replace the property of all objects with the same identifier ID | |
| summary | string | Template summary information. Note: If this field is passed, it will replace the property of all objects with the same identifier ID | |
| identifier | string | Template identifier ID. Note: If this field is passed, it will replace the title of all objects with the same identifier ID | |
| dashboardExtend | json | View additional data information | |
| dashboardMapping | array[json] | View variable field mapping configuration list | |
| iconSet | json | Dashboard icon information. Note: If this field is passed, it will replace the title of all objects 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 file name for the dashboard. Note: If this field is passed, it will replace the title of all objects with the same identifier ID | |
| thumbnail | string | Medium icon file name for the dashboard. Note: If this field is passed, it will replace the title of all objects 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] | View variable configuration list | |
| main.vars[#] | json | View variable configuration structure | |
| main.groups | array[string] | Chart group name list | |
| main.charts | array[json] | View chart configuration list | |
| main.charts[#] | json | Chart configuration structure |
dashboardMapping[#] Main Structure Explanation
| Parameter | Type | Required | Description |
|---|---|---|---|
main.charts[#] Main Structure Explanation
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Chart name |
| type | string | Required | 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, null is allowed if no group | |
| queries | array[json] | Required | Chart query statement structure list |
**Time Series Chart Structure main.charts[#].type=sequence Main Structure Parameters: **
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Chart name |
| type | string | Required | Chart type |
| pos | string | Required | Chart type |
| queries | array[json] | Required | Chart query statement structure list |