乐享知识库接口文档 请求URL
GET https://lxapi.lexiangla.com/cgi-bin/v1/kb/properties/{id}
请求头
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Authorization | 是 | 接口调用凭证 access_token 值格式:"Bearer access_token" 示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS" |
其他说明
| 事项 | 说明 |
|---|---|
| 权限要求 | 自定义属性管理 |
| 授权范围 | AppKey绑定团队时,入参id自定义属性需在授权的团队下 |
| 频率限制 | 3000次/分钟 |
URL 参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 自定义属性ID |
响应
{
"data": {
"type": "property",
"id": "9026e292ba27405c8e22c2bf7a1828ff",
"attributes": {
"name": "分类属性",
"created_at": "2025-10-16 10:48:51",
"updated_at": "2025-10-18 18:34:14",
"property_type": "category",
"options": [
{
"key": "skucffhh23i",
"value": "a",
"children": [
{
"key": "1hyud1hfbfn",
"value": "b",
"children": [
{
"key": "jx9747ck4go",
"value": "c",
"children": [
{
"key": "3vu4bclzzvm",
"value": "d",
"children": [
{
"key": "pfunyprp0kd",
"value": "e"
}
]
}
]
}
]
}
]
},
{
"key": "6zd03auqbet",
"value": "1",
"children": [
{
"key": "kric8lq5gup",
"value": "2"
}
]
}
],
"only_leaf": false,
"multiple": false,
"description": "分类介绍",
"default_value": "1/2"
},
"relationships": {
"owner": {
"data": {
"type": "staff",
"id": "LX001"
}
}
}
},
"included": [
{
"type": "staff",
"id": "LX001",
"attributes": {
"name": "LX001",
"english_name": "别名",
"organization": "开发组"
}
}
]
}
参数说明
| 参数 | 说明 |
|---|---|
| name | 属性名称 |
| property_type | 类型 text表示文本类型; select表示选项类型; category表示分类类型; |
| created_at | 创建时间 |
| updated_at | 更新时间 |
| description | 属性备注、描述 |
| multiple | bool值为true表示多选: 文本类型表示文本可以是多行文本; 选项类型表示是多选; |
| only_leaf | bool值为true表示仅可选择叶子节点,注意:仅分类类型有效,表示只能选择分类末尾的子节点 |
| default_value | 默认值 文本类型返回字符串 例:"text"; 单选类型返回选项字符串 例: "a"; 多选类型返回选项字符数组 例: ["a", "b"]; 分类类型返回当前选择的path路径 例: "路径1/路径2/路径3"; |
| options | 选项 选项类型表示包含的选项; 分类类型表示包含的分类; |
| options[].key | 选项或者分类的唯一标识,可用于更新该选项的value |
| options[].value | 选项或者分类的值 |
| options[].children | 仅分类类型有效,分类的嵌套子类,数据结构等同 options |
| owner | 属性创建者,可根据 id 在 included 中查找 |