跳到主要内容

GET 目录下的图纸列表(含归属与借阅)

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

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

请求参数(query)

字段类型必填说明
folderIdinteger(int64)是—
recursiveboolean——

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

请求示例

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

响应 data 字段

字段类型必填说明
idstring—关联记录ID
folderIdstring—目录ID
drawingIdstring—图纸档案ID
drawingNostring—图号
drawingNamestring—图纸名称
drawingStatusstring—图纸状态:DRAFT=草稿, PENDING_REVIEW=待评审, REVIEWING=评审中, REVIEWED=已评审, APPROVING=审批中, APPROVED=已审批, PUBLISHED=已发布, CHANGING=变更中, OBSOLETE=已作废
currentVersionNostring—当前生效版本号
refTypestring—引用类型 OWNED=归属 / BORROWED=借阅
sourceFolderIdstring—借阅来源目录ID
sourceProjectIdstring—借阅来源项目ID
sourceProjectNamestring—借阅来源项目名称
linkedVersionNostring—借阅锁定的版本号,为空表示跟随当前生效版本
borrowedAtstring(date-time)—借阅时间
borrowedByNamestring—借阅人姓名

错误处理​

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

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

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

← 返回图纸目录