简体中文
知识文件夹详情
约 648 字大约 2 分钟
2026-09-14
描述
查询指定知识文件夹的详细信息,返回该文件夹的节点数据(含当前用户的有效权限、是否有可见子文件夹等)。要求当前用户对该文件夹具有查看(VIEW)及以上权限。
请求说明
请求方式 :POST + application/json
请求路径 :https://${填入所在云的域名}/cgi/crm/v2/knowledge/folder/detail?thirdTraceId=${随机字符串}
请求头填写 :参考公共参数填写
请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| data | Map | 是 | 数据 |
| folderCode | String | 是 | 知识文件夹 code,可通过可见知识文件夹列表获取 |
请求示例
{
"data": {
"folderCode": "16"
}
}返回参数
返回结构与可见知识文件夹列表中的单个文件夹节点(nodes[] 元素)一致:
| 参数 | 类型 | 说明 |
|---|---|---|
| traceId | string | 请求唯一ID |
| errorDescription | string | 错误描述 |
| errorMessage | string | 错误信息 |
| errorCode | Int | 查看错误码 |
| data | Map | 文件夹节点数据 |
| folderCode | String | 知识文件夹 code |
| name | String | 文件夹名称 |
| parentFolderCode | String | 父文件夹 code,顶层文件夹为 null |
| level | Int | 文件夹层级(顶层为 1) |
| categorySource | String | 文件夹来源:自建或未对接外部系统的文件夹返回 UN_SYSTEM_INTEGRATION;对接外部系统的返回来源编码(如 KnowledgeArticleObj、NetworkDisk、WebPage 等) |
| category_id | String | 关联的分类 ID |
| pid | String | 父分类 ID |
| space_id | String | 文件夹真实所属的空间 ID |
| orderField | Int | 同层内的排序号 |
| hasChildren | Boolean | 是否存在当前用户可见的子文件夹 |
| shortcut | Boolean | 是否处于快捷方式展开上下文,本接口固定为 false |
| nodeType | String | 节点类型,本接口固定为 FOLDER |
| permission | String | 当前用户对该文件夹的有效权限(VIEW 及以上),取值见查询资源有效权限 |
返回示例
{
"traceId": "E-O.fktest4234.1000-20260914122000-xxxxxx",
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0,
"data": {
"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"
}
}注意事项
- 文件夹不存在时返回「资源不存在」类失败;文件夹存在但当前用户无查看(VIEW)权限时返回「无权限」类失败,两者错误类型可区分。
hasChildren仅统计当前用户可见(VIEW 及以上)的子文件夹;子文件夹明细请使用可见知识文件夹列表逐层查询。- 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
