版本管理接口
# 1 本地更新版本接口
简要描述
- 上传页创建版本,支持分片上传
请求 URL
/api/version/localUpdate
请求方式
- POST
请求 Body
{
"docId": "1580139277034573824",
"uploadId": 1630161235326480384,
"id": "FILE-1",
"fileMd5": "qwer1234asdf",
"name": "新文件2.dwg",
"size": 12345,
"file": 二进制文件,
"chunks": 10,
"chunk": 1
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 文档 id |
projectId | 是 | string | 项目 id |
file | 是 | File | 文件 |
id | 是 | string | 分片 id |
fileMd5 | 是 | string | 分片的 md5 |
uploadId | 是 | string | 由后端接口返回,所有分片保持一致 |
name | 是 | string | 上传的文件名称(完整名称,需要带后缀名) |
size | 是 | long | 文件总的大小(单位是 byte) |
chunks | 否 | int | 总的分片数 |
chunk | 否 | int | 当前分片,从 0 开始 |
返回示例
成功示例:
{
"msg": "操作成功",
"code": 0,
"data": {
"versionId": "123456678",
"versionName": "V1"
}
}
失败示例:
{
“msg”: “版本更新失败”,
“code”: 4500,
“data”: null
}
{
“msg”: “分片文件已损坏,请重新上传”,
“code”: 4154,
“data”: null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 2 版本列表接口
简要描述
- 版本列表
请求 URL
/api/version/list
请求方式
- GET
请求参数
/api/version/list?docId=123wqe&name=example
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 文档 id |
name | 否 | string | 版本名称 |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": [
{
"id": 12345,
"name": "v2",
"description": "新增了布局1",
"operator": "张三",
"operateTime": 12309485000,
"mark": "更新"
}
]
}
{
"code": 1,
"msg": "操作失败",
"data": null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | array | 数据 |
id | int | 版本 id |
name | string | 版本名称 |
description | string | 版本描述 |
operator | string | 操作人 |
operateTime | long | 操作时间(UTC) |
mark | string | 标记 |
备注
# 3 恢复到版本接口
简要描述
- 恢复到版本,将版本内容恢复到工作区
请求 URL
/api/version/restore
请求方式
- POST
请求示例
{
"docId": "123456787989",
"versionId": 1
}
参数(form-data)
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 目标文档 id |
versionId | 是 | int | 目标版本 id |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": null
}
{
"code": 1,
"msg": "操作失败",
"data": null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 4 删除版本接口
简要描述
- 删除版本
请求 URL
/api/version/delete
请求方式
- POST
请求 Body
{
"docId": "123456787989",
"versionId": 1
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 关联文档 id |
versionId | 是 | int | 被删除的版本 id |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": null
}
{
"code": 1,
"msg": "操作失败",
"data": null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 5 浏览页创建版本接口
简要描述
- 浏览页创建版本
请求 URL
/api/version/create
请求方式
- POST
请求 Body
{
"docId" : "12349238312131031212",
"name": "最终定稿",
"description": "这是一个示例"
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | long | 文档 id |
name | 是 | string | 版本名称 |
description | 否 | string | 备注 |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 6 云端更新版本接口
简要描述
- 云端上传更新版本
请求 URL
/api/version/cloudUpdate
请求方式
- POST
请求 Body
{
"docId": "12349238312131031212",
"cloudDocId": "43219238312131031212"
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string 文档 id | |
cloudDocId | 是 | string | 云端文档 id |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 7 查看版本详情接口
简要描述
- 查看版本详情
请求 URL
/api/version/detail
请求方式
- GET
请求示例
/api/version/detail?versionId=12345&docId=234
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
docId | 是 | string | 文档 id |
返回示例
{
"msg": "操作成功",
"code": 0,
"data": {
"versionId": 12345,
"name": "v2",
"description": "新增了布局1",
"operator": "张三",
"operateTime": 1677569356000
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
versionId | long | 版本 id(19 位) |
name | string | 版本名称 |
description | string | 版本描述 |
operator | string | 创建人 |
operateTime | long | 创建时间戳(毫秒) |
备注
# 8 编辑版本详情接口
简要描述
- 编辑版本详情
请求 URL
/api/version/edit
请求方式
- POST
请求 Body
{
"versionId": "1234",
"name": "v3",
"description": "测试版本"
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
name | 否 | string | 版本名称 |
description | 否 | string | 版本描述 |
返回示例
{
"msg": "操作成功",
"code": 0,
"data": null
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 9 切换版本接口
简要描述
- 切换版本时获取对应版本的显示数据
请求 URL
api/version/lmf
请求方式
- GET
请求示例
api/version/lmf?docId=123&handleId=1234&versionId=234
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 文档 id |
handleId | 否 | string | 句柄 id |
versionId | 否 | string | 版本 id(默认为最新版本) |
返回示例
{
"code": 0,
"msg": null,
"data": {
"lmfId": "1234",
"thumbnailId": "2345",
"layouts": [
{
"handleId": 34,
"layoutName": "模型",
"order": 0,
"isDefault": 1
}
],
"fonts": [
"simsun.ttf",
"yahei.ttf"
]
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
lmfId | string | 显示数据文件 id |
thumbnailId | string | 缩略图 id |
layouts | array | 布局列表 |
handleId | string | 句柄 id |
layoutName | string | layout 名称 |
order | int | 顺序 |
isDefault | int | 是否默认 |
fonts | array | 图纸关联字体 |
备注
# 10 获取版本关联文件接口
简要描述
- 切换版本时获取对应版本(layout)的显示数据
请求 URL
/api/version/file
请求方式
- GET
请求示例
api/version/file?fileId=1234&versionId=234
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
fileId | 是 | string | lmfId 或者 thumbnailId 或者 xrefLmfId |
versionId | 是 | string | 版本 id |
返回参数说明
二进制流
备注
# 11 获取文档详细信息(新增版本信息)接口
简要描述
- 获取指定文档的详细信息
请求 URL
/api/document/detail
请求方式
- GET
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | 是 | string | 文档 Id |
请求示例
/api/document/detail?id=124
返回示例
{
"msg": "string",
"code": "int",
"data": {
"creator": "张三",
"createTime": "12345",
"updater": "李四",
"updateTime": "12345",
"id": "string",
"type": "string",
"name": "string",
"projectId": "string",
"folderId": "string",
"sourceFileId": "string",
"owner": "王五",
"size": "int",
"delFlag": "string",
"completePath": "string",
"versions": [
{
"name": "v1",
"operateTime": 103456000,
"operator": "张三"
},
{
"name": "v2",
"operateTime": 113456000,
"operator": "张三"
},
{
"name": "v3",
"operateTime": 123456000,
"operator": "张三"
}
]
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
creator | string | 创建人 |
createTime | timestamp | 创建时间戳 |
updater | string | 更新人 |
updateTime | timestamp | 更新时间戳 |
id | string | 文档 id |
type | string | 文档类型 |
name | string | 文档名称 |
projectId | string | 项目 id |
folderId | string | 目录 id |
sourceFileId | string | 源文件 id |
owner | string | 文档属主 |
size | int | 文件大小 |
delFlag | string | 删除标识 |
completePath | string | 文档全路径 |
versions | array | 文档关联版本 |
name | string | 版本名称 |
operateTime | timestamp | 版本操作时间 |
operator | string | 版本操作人 |
备注
# 12 检查图纸状态接口
简要描述
- 创建版本之前检查图纸状态
请求 URL
/api/version/checkStatus
请求方式
- GET
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 文档 id |
请求示例
api/version/checkStatus?docId=123
返回示例
{
"code": 0,
"msg": "success",
"data": true
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
备注
# 13 获取版本的 xref 文件接口
简要描述
- 获取版本的 xref 显示数据
请求 URL
/api/version/xref
请求方式
- POST
请求 Body
{
"versionId": "123",
"docId": "234",
"handleId": "2134",
"xrefIds": ["123","345"]
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
docId | 是 | string | 文档 id |
handleId | 是 | string | 句柄 id |
xrefIds | 是 | array | xref 关联 id 列表 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"fileId": "1234"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
fileId | string | 显示数据 id |
备注
# 14 打印接口
简要描述
- 文档打印
请求 URL
/api/version/print
请求方式
- POST
请求 Body
{
"versionId": "123",
"docId": "1234567890",
"handleId": "12345678",
"ptType": "0",
"plotLayers": [
{
"layerId":"1",
"isPlottable": 0
}
],
"plotSettings": {
"plotType": "1",
"minPoint": ["0","0","0"],
"maxPoint": ["10","10","0"],
"centered": "0",
"scaleType": "0",
"plotRotation": "0",
"pageIndex": 1
},
"plotStamps": {
"seletion1" : "Drawing1.dwg",
"seletion2" : "123",
"stampLocation" : 0,
"stampOrientation" : 1
}
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
docId | 是 | string | 文档 id |
handleId | 是 | string | 句柄 id |
ptType | 是 | string | 输出文件类型 0:pdf; 1:ofd; 2:png; 3:jpg |
plotLayers | 否 | array | 设置图层是否打印,可以设置多个;如果不需要设置打印图层,则不需要传输 plotLayers 字段 |
layerId | 否 | string | 图层的 handleId |
isPlottable | 否 | int | 是否打印图层:0,不打印;1,打印 |
canvasWidth | 是 | string | canvas 的宽 |
canvasHeight | 是 | string | canvas 的高 |
plotSettings | 是 | object | 打印相关配置 |
plotType | 是 | string | 打印方式 1:直接打印; 4:窗口打印 |
minPoint | 是 | array | 窗口打印左下角的点,只需要 x 和 y 值 |
maxPoint | 是 | array | 窗口打印右上角的点,只需要 x 和 y 值 |
centered | 否 | string | 是否为中心打印, 0:否; 1:是。 option |
scaleType | 否 | string | 缩放比例, 默认为 0,实际配置方式有很多 |
plotRotation | 否 | string | 打印方向 0:纵向; 1:横向; 2:纵向+反向; 3:横向+反向 |
pageIndex | 否 | int | 纸张配置索引 |
plotStamps | 否 | object | 打印戳记相关配置 |
selection1 | 否(存在打印戳记的场合必填) | string | 前端拼接的戳记 |
selection2 | 否(存在打印戳记的场合必填) | string | 用户自定义的戳记 |
stampLocation | 否(存在打印戳记的场合必填) | int | 戳记相对于图纸的位置 (0:左下; 1:左上; 2:右上; 3:右下) |
stampOrientation | 否(存在打印戳记的场合必填) | int | 戳记显示的方向 0:纵向; 1:横向 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"fileId": "123"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
fileId | string | 生成的 pdf 文件 id |
备注
# 15 批量打印接口
简要描述
- 文档批量打印
请求 URL
/api/version/batchPrint
请求方式
- POST
请求 Body
{
"versionId": "123456",
"docId": "123456",
"handleId": "123456",
"layers": ["123","456"],
"filename":"fff",
"ptType": "0",
"plotLayers": [
{
"layerId":"1",
"isPlottable": 0
}
],
"plotStamps" :{
"stamp1": "aa",
"stamp2": "bb",
"stampOrientation" : "1",
"stampLocation" : "0"
}
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
docId | 是 | string | 文档 id |
layers | 否 | array | 打印图层, 为空则表示全选 |
handleId | 是 | string | 句柄 id |
filename | 是 | string | 输出文件名 |
ptType | 是 | int | 输出文件类型 0:pdf; 1:ofd; 2:png; 3:jpg |
plotLayers | 否 | array | 设置图层是否打印,可以设置多个;如果不需要设置打印图层,则不需要传输 plotLayers 字段 |
layerId | 否 | string | 图层的 handleId |
isPlottable | 否 | int | 是否打印图层:0,不打印;1,打印 |
plotStamps | 否 | object | 打印戳记相关配置 |
stamp1 | 否(选中戳记的场合必填) | string | 前端拼接的戳记 |
stamp2 | 否(选中戳记的场合必填) | string | 用户自定义的戳记 |
stampOrientation | 否(选中戳记的场合必填) | string | 戳记显示的方向 0:纵向; 1:横向 |
stampLocation | 否(选中戳记的场合必填) | string | 戳记相对于图纸的位置 0:左下; 1:左 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"fileId": "19278"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
fileId | string | 生成的 pdf 文件 id |
备注
# 16 获取文档详细信息(开图专用)接口
简要描述
- 获取文档详细信息(开图专用)
请求 URL
/api/document/view/detail
请求方式
- GET
请求 Body
/api/document/view/detail?id=124
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | 是 | string | 文档 Id |
返回示例
{
"code": 0,
"data": {
"delFlag": "NOT_DEL",
"folderld": "0",
"fonts": [
{
"fileld": "1000005",
"name": "simsun.ttf"
}
],
"id": "1706193437490065408",
"layouts": [
{
"ImfFileName": "layout default.lmf",
"createBy": 2368,
"createTime": 1695623194000,
"docld": "1706193437490065408",
"handleld": "34",
"isDefault": "YES",
"lmfFileSize": "1730",
"lmfFileld": "1706193455303274496",
"name": "模型",
"tabOrder": 0,
"transferResult": "SUCCESS",
"updateTime": 1695623194000
},
{
"createBy": 2368,
"createTime": 1695623194000,
"docld": "1706193437490065408",
"handleld": "456",
"isDefault": "NO",
"name": "布局1",
"tabOrder": 1
},
{
"createBy": 2368,
"createTime": 1695623194000,
"docld": "1706193437490065408",
"handleld": "461",
"isDefault": "NO",
"name": "布局2",
"tabOrder": 2
}
],
"name": "standard.dwq",
"projectld": "1706193347253809152",
"size": "43987",
"status": 0,
"type": "DRAWING",
"watermark":"李红涛\n2023-10-07"
},
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
creator | string | 创建人 |
createTime | timestamp | 创建时间戳 |
updater | string | 更新人 |
updateTime | timestamp | 更新时间戳 |
id | string | 文档 id |
type | string | 文档类型 |
name | string | 文档名称 |
projectId | string | 项目 id |
folderId | string | 目录 id |
sourceFileId | string | 源文件 id |
owner | string | 文档属主 |
size | int | 文件大小 |
delFlag | string | 删除标识 |
lmfFileName | string | 文档全路径 |
lmfFileSize | int | 文件大小 |
watermark | string | 水印 |
备注
# 17 查询文字查找信息接口
简要描述
- 查询文字查找信息
请求 URL
/api/version/text/info
请求方式
- GET
请求 Body
/api/version/text/info?versionId=1365656&handleId=10&docId=1806145638008160256
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
handleId | 否 | string | handleId,默认布局或者模型可以不传,切换布局时需要传 |
docId | 否 | string | 文档 ID,非必填 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"docId": "1806145638008160256",
"handleId": "12345",
"textFileId": "132465"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 文档信息,如果不存在字体查找 json 文件,则整个 data 为 null |
备注
# 18 下载文字查找文件接口
简要描述
- 根据版本 id 和布局 ID 查询文字查找信息
请求 URL
/api/version/text/download
请求方式
- GET
请求示例
/api/version/text/download?versionId=15233685336536523563&handleId=34
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
versionId | 是 | string | 版本 id |
handleId | 否 | string | handleId,默认布局或者模型可以不传,切换布局时需要传 |
返回参数说明
返回字体查找的二进制文件
备注
# 19 版本比对接口
简要描述
- 版本比对
请求 URL
/api/version/fcmp
请求方式
- POST
请求示例
{
"projectId": "1726631490890184448",
"docId": "1726631490510184448",
"baseId": "1625389118108000257",
"refId": "1625389255383375873",
"data": {
"fcmpRcShape": 0,
"fcmpRcMargin": 9,
"fcmpHatch": 1,
"fcmpText": 1
},
"viewport": {
"viewportId": "204834",
"centerPoint": [
337195.48844656127,
24639.604625444434,
0
],
"viewDirection": [
0,
0,
1
],
"viewCenter": [
0,
0
],
"height": 10032.567591829677,
"width": 22576.28084436882,
"twistAngle": 0,
"viewHeight": 10032.567591829677
},
"handleId": "34"
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
projectId | 否 | string | 文档归属项目 id |
docId | 是 | string | 版本关联文档 id |
baseId | 是 | string | 基准版本 id |
refId | 是 | string | 参照版本 id |
data | 是 | object | 比较条件对象 |
data.fcmpRcShape | 是 | int | 文件比较的云线形状,0 表示矩形,1 表示多边形 |
data.fcmpRcMargin | 是 | int | 文件比较的云线大小,范围:1~25 |
data.fcmpHatch | 是 | int | 文件比较是否显示图案填充,1 表示显示,0 表示不显示 |
data.fcmpText | 是 | int | 文件比较是否显示文字,1 表示显示,0 表示不显示 |
viewPort | 否 | object | 视口信息 |
viewPort.viewportId | 否 | string | 视口 id |
viewPort.centerPoint | 否 | array | 中心点 |
viewPort.viewDirection | 否 | array | 视口方向 |
viewPort.viewCenter | 否 | array | 视口中心 |
viewPort.height | 否 | float | 高度 |
viewPort.width | 否 | float | 宽度 |
viewPort.twistAngle | 否 | float | 角度 |
viewPort.viewHeight | 否 | float | 视口高度 |
viewPort.handleId | 否 | string | 句柄 id |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"docId": "1726633579483291648",
"lmfFileId": "173201927846771",
"size": 13608,
"fontList": [
"arial.ttf",
"arialn.ttf",
"century gothic.ttf",
"ltypeshp.shx",
"romans.shx",
"romantic.ttf",
"simplex.shx",
"simsun.ttf",
"宋体.ttf"
],
"layouts": [
{
"handleId": "30",
"isDefault": 0,
"layoutName": "FLP",
"order": 1
},
{
"handleId": "34",
"isDefault": 1,
"layoutName": "模型",
"order": 0
},
{
"handleId": "87684",
"isDefault": 0,
"layoutName": "PWP",
"order": 3
},
{
"handleId": "107074",
"isDefault": 0,
"layoutName": "PWP (2)",
"order": 4
},
{
"handleId": "73400",
"isDefault": 0,
"layoutName": "RCP",
"order": 2
}
],
"fcmpDiffExt": [
{
"maxPoint": {
"x": 331933.97204545035,
"y": 27677.162635756304,
"z": 0
},
"minPoint": {
"x": 331617.76876406977,
"y": 26910.959354375747,
"z": 0
}
},
{
"maxPoint": {
"x": 331644.25689671305,
"y": 25579.94248936304,
"z": 0
},
"minPoint": {
"x": 330528.05361533246,
"y": 24463.739207982482,
"z": 0
}
},
{
"maxPoint": {
"x": 331247.50240475446,
"y": 26486.530168466004,
"z": 0
},
"minPoint": {
"x": 330381.45836052607,
"y": 25620.486124237603,
"z": 0
}
},
{
"maxPoint": {
"x": 329061.3949566128,
"y": 22272.153932785226,
"z": 0
},
"minPoint": {
"x": 328745.19157658546,
"y": 21755.95065140469,
"z": 0
}
},
{
"maxPoint": {
"x": 334793.97204545035,
"y": 27677.162635756304,
"z": 0
},
"minPoint": {
"x": 333827.76876406977,
"y": 26910.959354375747,
"z": 0
}
},
{
"maxPoint": {
"x": 336038.91473732574,
"y": 27367.444407043033,
"z": 0
},
"minPoint": {
"x": 335272.71145594516,
"y": 26601.241125662476,
"z": 0
}
},
{
"maxPoint": {
"x": 339690.4366064037,
"y": 25705.99690347263,
"z": 0
},
"minPoint": {
"x": 335522.71145594516,
"y": 20529.29470340335,
"z": 0
}
},
{
"maxPoint": {
"x": 334878.8838898931,
"y": 22433.048668127616,
"z": 0
},
"minPoint": {
"x": 331876.86323416186,
"y": 20819.741939384392,
"z": 0
}
},
{
"maxPoint": {
"x": 340865.63780121977,
"y": 29045.462942324062,
"z": 0
},
"minPoint": {
"x": 337573.10274325276,
"y": 27036.678633700496,
"z": 0
}
},
{
"maxPoint": {
"x": 333268.0092821293,
"y": 24025.172172292285,
"z": 0
},
"minPoint": {
"x": 332158.9590705288,
"y": 23408.97275515285,
"z": 0
}
}
],
"fcmpErrorFlag": 512,
"baseVersionName": "old.dwg",
"compareVersionName": "new.dwg"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
docId | string | 文档 id |
lmfFileId | string | 差异数据临时文件 id |
size | int | 差异数据临时文件大小 |
fontList | array | 基准图纸和参照图纸中包含的字体列表 |
layouts | array | 基准图纸布局列表 |
handleId | string | 句柄 id |
isDefault | string | YES 表示是,NO 表示否 |
layoutName | string | layout 名称 |
order | int | 布局顺序 |
fcmpDiffExt | array | 差异点坐标 |
fcmpErrorFlag | int | 错误 flag |
baseVersionName | string | 基准版本名称 |
compareVersionName | string | 参照版本名称 |
备注
# 20 文件列表图纸比对(非版本)口
简要描述
- 文件列表图纸比对(非版本)
请求 URL
/api/layout/fcmp
请求方式
- POST
请求示例
{
"projectId": "1726631490890184448",
"docId": "1625389118108000257",
"refId": "1625389255383375873",
"handleId": "1234",
"data": {
"fcmpRcShape": 0,
"fcmpRcMargin": 9,
"fcmpHatch": 1,
"fcmpText": 1
},
"viewport": {
"viewportId": "204834",
"centerPoint": [
337195.48844656127,
24639.604625444434,
0
],
"viewDirection": [
0,
0,
1
],
"viewCenter": [
0,
0
],
"height": 10032.567591829677,
"width": 22576.28084436882,
"twistAngle": 0,
"viewHeight": 10032.567591829677
},
"handleId": "34"
}
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
projectId | 否 | string | 文档归属项目 id |
docId | 是 | string | 版本关联文档 id |
baseId | 是 | string | 基准版本 id |
refId | 是 | string | 参照版本 id |
data | 是 | object | 比较条件对象 |
data.fcmpRcShape | 是 | int | 文件比较的云线形状,0 表示矩形,1 表示多边形 |
data.fcmpRcMargin | 是 | int | 文件比较的云线大小,范围:1~25 |
data.fcmpHatch | 是 | int | 文件比较是否显示图案填充,1 表示显示,0 表示不显示 |
data.fcmpText | 是 | int | 文件比较是否显示文字,1 表示显示,0 表示不显示 |
viewPort | 否 | object | 视口信息 |
viewPort.viewportId | 否 | string | 视口 id |
viewPort.centerPoint | 否 | array | 中心点 |
viewPort.viewDirection | 否 | array | 视口方向 |
viewPort.viewCenter | 否 | array | 视口中心 |
viewPort.height | 否 | float | 高度 |
viewPort.width | 否 | float | 宽度 |
viewPort.twistAngle | 否 | float | 角度 |
viewPort.viewHeight | 否 | float | 视口高度 |
viewPort.handleId | 否 | string | 句柄 id |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"docId": "1726633579483291648",
"lmfFileId": "12347889",
"size": 34928,
"fontList": [
"arial.ttf",
"arialn.ttf",
"century gothic.ttf",
"ltypeshp.shx",
"romans.shx",
"romantic.ttf",
"simplex.shx",
"simsun.ttf",
"宋体.ttf"
],
"layouts": [
{
"handleId": "30",
"isDefault": 0,
"layoutName": "FLP",
"order": 1
},
{
"handleId": "34",
"isDefault": 1,
"layoutName": "模型",
"order": 0
},
{
"handleId": "87684",
"isDefault": 0,
"layoutName": "PWP",
"order": 3
},
{
"handleId": "107074",
"isDefault": 0,
"layoutName": "PWP (2)",
"order": 4
},
{
"handleId": "73400",
"isDefault": 0,
"layoutName": "RCP",
"order": 2
}
],
"fcmpDiffExt": [
{
"maxPoint": {
"x": 331933.97204545035,
"y": 27677.162635756304,
"z": 0
},
"minPoint": {
"x": 331617.76876406977,
"y": 26910.959354375747,
"z": 0
}
},
{
"maxPoint": {
"x": 331644.25689671305,
"y": 25579.94248936304,
"z": 0
},
"minPoint": {
"x": 330528.05361533246,
"y": 24463.739207982482,
"z": 0
}
},
{
"maxPoint": {
"x": 331247.50240475446,
"y": 26486.530168466004,
"z": 0
},
"minPoint": {
"x": 330381.45836052607,
"y": 25620.486124237603,
"z": 0
}
},
{
"maxPoint": {
"x": 329061.3949566128,
"y": 22272.153932785226,
"z": 0
},
"minPoint": {
"x": 328745.19157658546,
"y": 21755.95065140469,
"z": 0
}
},
{
"maxPoint": {
"x": 334793.97204545035,
"y": 27677.162635756304,
"z": 0
},
"minPoint": {
"x": 333827.76876406977,
"y": 26910.959354375747,
"z": 0
}
},
{
"maxPoint": {
"x": 336038.91473732574,
"y": 27367.444407043033,
"z": 0
},
"minPoint": {
"x": 335272.71145594516,
"y": 26601.241125662476,
"z": 0
}
},
{
"maxPoint": {
"x": 339690.4366064037,
"y": 25705.99690347263,
"z": 0
},
"minPoint": {
"x": 335522.71145594516,
"y": 20529.29470340335,
"z": 0
}
},
{
"maxPoint": {
"x": 334878.8838898931,
"y": 22433.048668127616,
"z": 0
},
"minPoint": {
"x": 331876.86323416186,
"y": 20819.741939384392,
"z": 0
}
},
{
"maxPoint": {
"x": 340865.63780121977,
"y": 29045.462942324062,
"z": 0
},
"minPoint": {
"x": 337573.10274325276,
"y": 27036.678633700496,
"z": 0
}
},
{
"maxPoint": {
"x": 333268.0092821293,
"y": 24025.172172292285,
"z": 0
},
"minPoint": {
"x": 332158.9590705288,
"y": 23408.97275515285,
"z": 0
}
}
],
"fcmpErrorFlag": 512,
"baseFileName": "old.dwg",
"compareFileName": "new.dwg"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
msg | string | 消息 |
data | obj | 数据 |
docId | string | 文档 id |
lmfFileId | string | 差异数据临时文件 id |
size | int | 差异数据临时文件大小 |
fontList | array | 基准图纸和参照图纸中包含的字体列表 |
layouts | array | 基准图纸布局列表 |
fcmpDiffExt | array | 差异点坐标 |
fcmpErrorFlag | int | 错误 flag |
baseFileName | string | 基准图纸名称 |
compareFileName | string | 参照图纸名称 |
备注
# 21 历史版本文件下载接口
简要描述
- 历史版本文件下载
请求 URL
/api/version/download
请求方式
- GET
请求示例
/api/version/download?docId=123&versionId=234
参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
docId | 是 | string | 图纸 id |
versionId | 是 | string | 图纸版本 id |
返回示例
文件流
返回参数说明
文件流
备注