跳到主要内容

GET 目录树(onlyPermitted=true 仅返回有权限的分支)

GET 查询。query 参数见接口参考。

接口编码所需范围后端接口
project.drawing.folders.treeproject:readGET /v1/drawing/folders/tree(comap-project)

请求参数(query)

字段类型必填说明
onlyPermittedboolean——

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "project.drawing.folders.tree",
"query": {}
}'

响应 data 字段

字段类型必填说明
idstring—目录ID
namestring—目录名称
parentIdstring—父目录ID
ancestorsstring—祖先链,逗号分隔
sortNuminteger(int32)—同级排序号
iconstring—图标
colorstring—颜色
descriptionstring—描述
drawingCountinteger(int32)—该目录直接归属的图纸数量(不含子目录、不含借阅)
permLevelstring—当前用户在该目录上的最高权限档位 MANAGE/EDIT/VIEW,无权限为空
creatorNamestring—创建人姓名
createTimestring(date-time)—创建时间
childrenDrawingFolderTreeVO[]—子目录

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 project:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-project 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回图纸目录