新建用户视图¶
POST /api/v1/dashboard/add
概述¶
新建单个用户视图
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| sourceDashboardUUID | string | 源视图ID 允许为空: False 允许为空字符串: True 最大长度: 128 |
|
| name | string | Y | 视图名称 允许为空: False 最大长度: 256 |
| desc | string | 描述 例子: 描述1 允许为空: False 最大长度: 2048 |
|
| identifier | string | 标识id --2024.12.25 新增标识id 例子: xxxx 允许为空: False 允许为空字符串: True 最大长度: 128 |
|
| templateInfos | json | 自定义模板数据 例子: {} 允许为空: False 允许为空字符串: False |
|
| dashboardBidding | json | mapping, 默认为{} 例子: {} 允许为空: False |
|
| specifyDashboardUUID | string | 指定新建仪表板的uuid, 必须以dsbd_custom_为前缀后接 32 位长度的小写字母数字例子: dsbd_custom_xxxx32 允许为空: False 允许为空字符串: False $matchRegExp: ^dsbd_custom_[a-z0-9]{32}$ |
参数补充说明¶
请求主体结构说明
| 参数名 | type | 说明 |
|---|---|---|
| name | string | 名称 |
| desc | string | 描述 |
| identifier | string | 标识id --2024.12.25新增 |
| dashboardBidding | dict | 仪表板绑定的信息 |
| sourceDashboardUUID | string | 克隆 仪表板 或者 内置用户视图 的UUID |
| templateInfos | dict | 克隆 内置系统视图 的模板信息 |
绑定内置视图字段 dashboardBidding 说明
内部支持 op 值 in/wildcard
dashboardBidding 字段示例:
{
"service": [
{
"value": [
"*"
],
"op": "in"
}
],
"app_id": [
{
"value": [
"test0"
],
"op": "wildcard"
}
],
"label": [
{
"value": [
"勿删"
],
"op": "in"
}
]
}
请求例子¶
curl 'https://openapi.guance.com/api/v1/dashboard/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Accept-Language: zh' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Accept: application/json, text/plain, */*' \
--data-raw '{"name":"001绑定内置视图","dashboardBidding":{"service":[{"value":["*"],"op":"in"}],"app_id":[{"value":["test0"],"op":"wildcard"}],"label":[{"value":["勿删"],"op":"in"}]}}' \
--compressed
响应¶
{
"code": 200,
"content": {
"chartGroupPos": [],
"chartPos": [],
"createAt": 1713513331,
"createdWay": "manual",
"creator": "wsak_xxxx32",
"identifier": "",
"dashboardBidding": {
"app_id": [
{
"op": "wildcard",
"value": [
"test0"
]
}
],
"label": [
{
"op": "in",
"value": [
"勿删"
]
}
],
"service": [
{
"op": "in",
"value": [
"*"
]
}
]
},
"dashboardBindSet": [],
"declaration": {
"b": [
"asfawfgajfasfafgafwba",
"asfgahjfaf"
],
"business": "aaa",
"organization": "64fe7b4062f74d0007b46676"
},
"deleteAt": -1,
"desc": "",
"extend": {},
"iconSet": {},
"id": 5091,
"isPublic": 1,
"mapping": [],
"name": "001绑定内置视图",
"ownerType": "inner",
"status": 0,
"type": "CUSTOM",
"updateAt": 1713513331,
"updator": "wsak_xxxx32",
"uuid": "dsbd_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-2FB0228E-1660-4557-AF7B-688176108C28"
}