【对象分类配置】创建¶
POST /api/v1/objc_cfg/create
概述¶
创建对象分类配置
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| sourceType | string | Y | 来源类型, 默认值为custom_object允许为空: False 例子: custom_object 可选值: ['object', 'custom_object'] |
| objcGroupUUID | string | 业务分组UUID 允许为空: False 例子: objcg_xxxx 允许为空字符串: True 最大长度: 64 |
|
| fields | array | 自定义属性字段(上报的数据中必然包含这些字段，否则上报的数据将被丢弃) 允许为空: False 例子: [{'name': 'ak', 'alias': '机枪'}] |
|
| templateInfo | json | 模版配置信息 允许为空: False 例子: {} |
参数补充说明¶
fields参数说明
该参数以列表形式存储绑定的字段信息，列表成员参数如下
| 参数名 | 类型 | 描述 |
|---|---|---|
| name | string | 字段名 |
| alias | string | 字段别名 |
templateInfo参数说明
详细的结构说明请参考【新建资源查看器-JSON配置-模版配置说明】
1. source 参数说明 定义资源的所属分类以及分类需要在 UI 页面显示的文本内容，列表成员参数如下
| 参数名 | 类型 | 描述 |
|---|---|---|
| key | string | 资源分类 |
| name | string | 资源分类别名 |
2. filters 参数说明 定义资源查看器在快捷筛选处的默认列出显示字段，格式如下所示：
3. columns 参数说明 定义资源查看器在列表的默认列出显示字段，格式如下所示：
4. views 参数说明
| 参数 | 必填 | 描述 | 写法示例 |
|---|---|---|---|
| title | / | Tab 展示标题 | "文本" |
| required | false | Tab 页是否不显示，固定值：true、false。
|
"false" |
| keys | / | 联动required参数，可配置关键字段和字段值匹配逻辑，匹配上则显示。注意：此参数应用情况下，required 参数值必须为 true |
|
| timerange | default | 界面数据查询时间范围定义。基本格式：
|
|
| viewType | / | 页面类型。当前支持"内置页面"和"内置视图"两个类型，分别对应 "component" 和 "dashboard"。 | / |
| viewName | / | 页面名称。若页面类型是内置页面，则需要填写页面的相对路径地址；若页面类型是内置视图，则填写视图名称即可。参考下方【关联内置页面】【关联内置视图】说明 | / |
5. templateInfo 参数示例
{
"main": [
{
"class":"custom_object",
"source": {
"key":"资源分类",
"name":"资源分类别名"
},
"filters":[
{
"key":"字段名称"
},
{
"key":"字段名称"
}
],
"table":{
"columns":[
{
"key":"字段名称",
},
{
"key":"字段名称",
}
],
},
"detail":{
"views":[
{
"title":"Tab 标题",
"required":"false",
"keys":{},
"view_type": "component",
"viewName":"内置页面"
},
{
"title":"Tab 标题",
"required":"false",
"keys":{},
"timerange":"default",
"view_type": "dashboard",
"viewName":"内置视图"
}
]
}
}
],
"title": "资源分类或别名"
}
请求例子¶
curl 'https://openapi.guance.com/api/v1/objc_cfg/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"sourceType":"custom_object","objcGroupUUID":"objcg_xxxx","fields":[{"name":"name"}],"templateInfo":{"main":[{"class":"custom_object","source":{"key":"test","name":""},"filters":[],"fills":[],"groups":[],"table":{"columns":[],"detail":{"views":[{"keys":{},"viewType":"dashboard","viewName":"NtpQ 监控视图","title":"viewer","required":true,"timerange":"default"}]}}}],"title":"test"}}' \
--compressed
响应¶
{
"code": 200,
"content": {
"sourceType": "custom_object",
"name": "test",
"alias": "",
"workspaceUUID": "wksp_xxxx",
"objcGroupUUID": "objcg_xxx",
"dashboardBindSet": [],
"fields": [
{
"name": "name"
}
],
"extend": {
"fills": [],
"groups": [],
"columns": [],
"filters": [],
"iconSet": {},
"tableDetailViews": [
{
"keys": {},
"viewType": "dashboard",
"viewName": "NtpQ 监控视图",
"title": "viewer",
"required": true,
"timerange": "default"
}
]
},
"id": 260,
"uuid": "objc_xxxx",
"status": 0,
"creator": "acnt_xxxx",
"updator": "acnt_xxxx",
"createAt": 1734576782,
"deleteAt": -1,
"updateAt": 1734590084.4779553
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "96555412482790535"
}