跳到主要内容

GET 档案详情

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

接口编码所需范围后端接口
project.drawing.archives.detailproject:readGET /v1/drawing/archives/detail(comap-project)

请求参数(query)

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

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

请求示例

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

响应 data 字段

字段类型必填说明
idstring—档案ID
drawingNostring—图号
namestring—图纸名称
shortNamestring—简称
typeCodestring—图纸类型码
typeNamestring——
categoryNamestring——
categoryCodestring—图纸分类码
deptIdstring—责任部门ID
deptNamestring—责任部门名称
statusstring—状态:DRAFT=草稿, PENDING_REVIEW=待评审, REVIEWING=评审中, REVIEWED=已评审, APPROVING=审批中, APPROVED=已审批, PUBLISHED=已发布, CHANGING=变更中, OBSOLETE=已作废
currentVersionIdstring—当前版本ID
currentVersionNostring—当前版本号
currentVersionDatestring(date-time)—当前版本发布时间
materialstring—材质
specstring—规格
modelstring—型号
weightstring—重量
surfaceTreatmentCodesstring—surfaceTreatmentCodes
heatTreatmentCodesstring—heatTreatmentCodes
techRequirementsstring—技术要求
inspectionRequirementsstring—检验要求
keyCharacteristicsstring—关键特性
isKeyPartinteger(int32)—是否关键件
isDrawingPurchaseinteger(int32)—是否按图采购
isVersionControlledinteger(int32)—是否版本受控
allowOldVersioninteger(int32)—是否允许使用旧版本
substituteConditionstring—旧版替代条件
relatedMaterialIdstring—关联物料ID
relatedMaterialCodestring—关联物料编码
relatedMaterialNamestring—关联物料名称
defaultSupplierIdstring—默认供应商ID
defaultSupplierNamestring—默认供应商名称
requireIncomingQcinteger(int32)—是否需来料检验
requireFirstArticleinteger(int32)—是否需首件检验
canOutsourceinteger(int32)—是否可外协:0=否, 1=是
enableBatchTraceinteger(int32)—是否启用批次追溯
controlTypestring—受控类型(取值来源:受控类型配置,默认 UNCONTROLLED)
controlledNostring—受控编号
controlledPlannedCountinteger(int32)—受控计划份数
controlledCopyPrefixstring—受控副本号前缀
controlledCopyCountinteger(int32)—受控副本总数
confidentialityLevelstring—保密等级(取值来源:保密等级配置)
confidentialityLevelNamestring——
relatedProjectIdstring—关联项目ID(已废弃,仅兼容历史调用方,新代码请用 projects)
projects3DrawingProjectRefVO[]—关联项目列表
relatedEquipmentIdstring—关联设备ID
relatedBomIdstring—主关联BOMID
enabledinteger(int32)—是否启用
obsoleteReasonstring—作废原因
remarkstring—备注
creatorIdstring—创建人ID
creatorNamestring—创建人姓名
createTimestring(date-time)—创建时间
updateTimestring(date-time)—更新时间
versions29DrawingVersionVO[]—版本列表
permittedOperationsstring[]—当前用户可执行的操作集 VIEW/DOWNLOAD/PRINT/SHARE
canEditboolean—canEdit
canManageboolean—canManage
ownedFolderIdstring—归属目录ID(OWNED 关联,未归档为空)
ownedFolderNamestring—归属目录名称
latestVersionNostring—最新版本号(含草稿,未发布时用于兜底展示)
customFieldValues10FieldDataBO[]—自定义字段值
tabCounts5DrawingArchiveTabCountsVO—图纸详情 Tab 条数

错误处理​

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

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

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

← 返回图纸档案管理