跳到主要内容

POST 版本列表

POST 查询。body 为 JSON 对象。

接口编码所需范围后端接口
project.drawing.versions.listproject:readPOST /v1/drawing/versions/list(comap-project)

请求体字段(body)

字段类型必填说明
drawingIdinteger(int64)—图纸档案ID
drawingNostring—图号
statusstring—状态:DRAFT=草稿, APPROVED=审批通过, PUBLISHED=已发布, ARCHIVED=已归档, OBSOLETE=已作废
isCurrentinteger(int32)—是否当前生效版本
isMajorChangeinteger(int32)—是否重大变更
pageNuminteger(int32)—页码
pageSizeinteger(int32)—每页条数

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "project.drawing.versions.list",
"body": {
"pageNum": 1,
"pageSize": 10
}
}'

响应 data 字段

字段类型必填说明
idstring—版本ID
drawingIdstring—图纸档案ID
drawingNostring—图号
drawingNamestring—图纸名称
versionNostring—版本号
statusstring—状态:DRAFT=草稿, APPROVED=审批通过, PUBLISHED=已发布, ARCHIVED=已归档, OBSOLETE=已作废
isCurrentinteger(int32)—是否当前生效版本
versionTypestring—版本类型:FORMAL=正式版(取值可扩展)
changeTypeCodestring—变更类型码
changeReasonstring—变更原因
changeSummarystring—变更摘要
isMajorChangeinteger(int32)—是否重大变更
submitterIdstring—提交人ID
submitterNamestring—提交人姓名
submitTimestring(date-time)—提交时间
reviewerNamestring—审核人姓名
reviewTimestring(date-time)—审核时间
reviewResultstring—审查结果
reviewOpinionstring—审查意见
publisherNamestring—发布人姓名
publishTimestring(date-time)—发布时间
effectiveDatestring(date-time)—生效日期
effectSuggestionstring—生效建议
affectsPurchaseinteger(int32)—影响采购
affectsBominteger(int32)—影响BOM
affectsInventoryinteger(int32)—影响库存
affectsProductioninteger(int32)—影响生产
affectsAftersalesinteger(int32)—影响售后
createTimestring(date-time)—创建时间

错误处理​

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

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

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

← 返回图纸版本管理