简体中文
可见知识文件夹列表
约 750 字大约 3 分钟
2026-09-14
描述
查询指定知识空间内、当前用户可见的知识文件夹,采用逐层加载方式:不传 parentFolderCode 返回该空间的根层文件夹;传入则返回该父文件夹的直接子文件夹。
请求说明
请求方式 :POST + application/json
请求路径 :https://${填入所在云的域名}/cgi/crm/v2/knowledge/folder/list?thirdTraceId=${随机字符串}
请求头填写 :参考公共参数填写
请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| data | Map | 是 | 数据 |
| spaceId | String | 是 | 知识空间 ID,可通过可见知识空间列表获取 |
| parentFolderCode | String | 否 | 父文件夹 code。为空表示查询根层文件夹;非空表示查询其父节点的直接子文件夹 |
请求示例
{
"data": {
"spaceId": "space-001"
}
}返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| traceId | string | 请求唯一ID |
| errorDescription | string | 错误描述 |
| errorMessage | string | 错误信息 |
| errorCode | Int | 查看错误码 |
| data | object | 返回数据 |
| nodes | Array | 当前层的可见文件夹节点 |
| nodes[].folderCode | String | 知识文件夹 code |
| nodes[].name | String | 文件夹名称 |
| nodes[].parentFolderCode | String | 父文件夹 code,根层恒为 null |
| nodes[].level | Int | 层级,根层为 1 |
| nodes[].categorySource | String | 文件夹来源:自建或未对接外部系统的文件夹返回 UN_SYSTEM_INTEGRATION;对接外部系统的返回来源编码(如 KnowledgeArticleObj、NetworkDisk、WebPage 等) |
| nodes[].category_id | String | 关联的分类 ID |
| nodes[].pid | String | 父分类 ID |
| nodes[].space_id | String | 文件夹真实所属的空间 ID |
| nodes[].orderField | Int | 当前层内的排序号 |
| nodes[].hasChildren | Boolean | 是否还有可见的子文件夹 |
| nodes[].shortcut | Boolean | 是否处于快捷方式展开上下文(非节点展示类型) |
| nodes[].nodeType | String | 节点类型:FOLDER 普通文件夹、SHORTCUT 快捷方式。仅根层的快捷方式入口节点为 SHORTCUT |
| nodes[].permission | String | 当前用户对该文件夹的权限级别,取值见查询资源有效权限 |
返回示例
{
"traceId": "E-O.fktest4234.1000-20260914121000-xxxxxx",
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0,
"data": {
"nodes": [
{
"folderCode": "16",
"name": "安装指南",
"parentFolderCode": null,
"level": 1,
"categorySource": "UN_SYSTEM_INTEGRATION",
"category_id": "67f1xxxx",
"pid": null,
"space_id": "space-001",
"orderField": 1,
"hasChildren": true,
"shortcut": false,
"nodeType": "FOLDER",
"permission": "VIEW"
}
]
}
}注意事项
- 本接口为逐层查询,请根据返回的
hasChildren判断是否需要以该节点folderCode作为parentFolderCode继续查询下一层。文件夹层级默认最多支持 10 层。 - 仅返回当前用户可见的节点;不可见的文件夹不会出现在结果中。对空间或父文件夹无查看权限时,返回空的
nodes数组,接口仍成功。 SHORTCUT类型节点指向其他文件夹,其space_id指向真实所属空间。- 文件夹下的知识条目请使用知识条目列表,以
category字段的IN过滤条件传入文件夹 code。 - 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
