开放平台

文档管理接口

# 1 新增文档（创建文件夹）接口

简要描述

  • 新增一条文档信息记录。

请求 URL

  • /api/document

请求方式

  • POST

请求 Body

{
  	"name": "Test",
	"folderId": "0",
	"type": "FOLDER"
   }

参数

参数名 必选 类型 说明
folderId 是 string 文件夹(0 表示根目录)
name 是 string 文档名称
type 是 string 文档类型 (FOLDER 文件夹；DRAWING 图纸；）

返回示例*

{
		"msg":"操作成功",
		"code":0,
		"data":{
			"docId":1541272558027018240
		}
	}

返回参数说明

参数名 类型 说明
docId long 文档 Id

备注

# 2 修改文档信息接口

简要描述

  • 修改指定文档名称信息。

请求 URL

  • /api/document

请求方式

  • PUT

请求 Body

{
    "id": "1541272558027018240",
	"name": "Test1"
  }

参数

参数名 必选 类型 说明
id 是 string 文档的 Id
name 是 string 文档的新名称

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": null
  }

返回参数说明

参数名 类型 说明

备注

# 3 删除文档信息接口

简要描述

  • 删除指定的文档信息记录，按照参数 id 的个数，支持单个和批量删除。

请求 URL

  • /api/document

请求方式

  • DELETE

请求示例

id: 123,234,345
projectId: 1000

参数（form-data）

参数名 必选 类型 说明
id 是 string 多个 docId 使用逗号分隔
projectId 是 string 项目 id，SDK 场景下默认传 1000

返回示例*

{
    "msg": "操作成功",
	"code": 0
  }

返回参数说明

参数名 类型 说明

备注

# 4 文档名称重复校验接口

简要描述

  • 在上传文件、新增文档、文档重命名等操作之前判断文档名称是否重复，若重复，返回后端建议的新文档名称。

请求 URL

  • /api/document/checkRepetition

请求方式

  • PUT

请求 Body

{
  "name": "Test1",
	"id":"123332233434",
	"folderId":"123434454545454"，
	"type": "FOLDER",
	"autoRename": false
  }

参数

参数名 必选 类型 说明
name 是 String 文档名称
id 否 String 需要修改的文档 id，在文档重命名场景下，必填
folderId 是 String 父级文档 id
type 是 string 文档类型，只能是 FOLDER、DRAWING
autoRename 否 bool 是否自动重命名

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": {
		"repeated": true,
		"id": "1111",
		"name": "testMe"

    }
  }

返回参数说明

参数名 类型 说明
msg string 接口状态信息
code int 接口状态码
data object 接口返回数据
repeated bool 文档名称是否重复，true 为重复，false 为不重复
id string 重复的文档 id，autoRename 为 false 的时候返回
name string 重命名后的文档名称，autoRename 为 true 或者不传的时候返回

备注

# 5 清空回收站接口

简要描述

  • 清空回收站。

请求 URL

  • /api/document/clearRecycle

请求方式

  • DELETE

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": true
  }

备注

# 6 根据文档 id 获取文件大小（辅助分段下载）接口

简要描述

  • 根据 docId 获取需要下载的文件的大小，辅助分段下载接口

请求 URL

  • /api/document/fileSize

请求方式

  • GET

参数

参数名 必选 类型 说明
docId 是 string 要下载的文档 id

返回示例*

{
    "msg": "操作成功",
    "code": 0,
    "data": 50000
  }

返回参数说明

参数名 类型 说明
data int 文件大小（单位是 byte）

备注

# 7 获取文档详细信息接口

简要描述

  • 获取指定文档的详细信息的旧版本接口，数据比较全，性能略差。

请求 URL

  • /api/document/detail

请求方式

  • GET

请求示例

/api/document/detail?id=1749344237187178496

参数

参数名 必选 类型 说明
id 是 string 文档 Id

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "createBy": 2135,
        "creator": "122****1234",
        "createTime": 1705911142000,
        "updateBy": 2135,
        "updateTime": 1705911142000,
        "id": "1749344237187178496",
        "type": "DRAWING",
        "name": "19幢房产分户图.dwg",
        "projectId": "1742366089172205568",
        "folderId": "0",
        "sourceFileId": "1749344237187178497",
        "ownerId": 2135,
        "size": "2914858",
        "delFlag": "NOT_DEL",
        "transferResult": 2,
        "completePath": "/",
        "layouts": [
            {
                "createBy": 2135,
                "createTime": 1705911147000,
                "docId": "1749344237187178496",
                "handleId": "579",
                "name": "模型",
                "tabOrder": 0,
                "isDefault": "YES",
                "lmfFileId": "1749344258620071936",
                "transferResult": "SUCCESS"
            },
            {
                "createBy": 2135,
                "createTime": 1705911147000,
                "docId": "1749344237187178496",
                "handleId": "580",
                "name": "Layout1",
                "tabOrder": 1,
                "isDefault": "NO"
            }
        ],
        "fonts": [
            {
                "fileId": "1000005",
                "name": "simsun.ttf"
            }
        ],
        "status": 0,
        "isConcerned": "NO",
        "srcFileUpdateTime": 1705911142000,
        "versions": [
            {
                "name": "origin",
                "versionId": "1749344239368216576",
                "operator": "122****1234",
                "operateTime": 1705911143000,
                "mark": "upload drawing",
                "isOrigin": true,
                "isCurrent": "",
                "avatarUrl": ""
            },
            {
                "name": "current",
                "versionId": "1749344242316812288",
                "operator": "122****1234",
                "operateTime": 1705911143000,
                "mark": "",
                "isOrigin": "",
                "isCurrent": true,
                "avatarUrl": ""
            }
        ]
    }
}

返回参数说明

参数名 类型 说明
createBy int 创建人 id
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 文件大小，单位：byte
delFlag string 删除标识
completePath string 文档全路径
layouts array 文档 layout 信息列表
layouts.createBy int 转换人 id
layouts.createTime timestamp 转换时间戳
layouts.docId string 文档 id
layouts.handleId string 文档 layout 的 handleId，layout 的唯一标记
layouts.name string 文档 layout 的名称
layouts.tabOrder string 文档 layout 的顺序，从 0 开始
layouts.isDefault string 是否是默认 layout：“YES”，是；“NO”：否；
layouts.lmfFileId string 文档 layou 对应的显示数据文件的 id
layouts.transferResult string 文档 layou 对应的转换结果：“SUCCESS”，成功；“FAIL”，失败；“IN_PROGRESS”，处理中；“QUEUE”，排队中；“OTHER”，其它；
fonts array 文档中用到的并且文档所在项目中拥有的字体列表
fonts.name string 字体名称
fonts.fileId string 字体 id
versions array 文档关联版本
versions.name string 版本名称
versions.versionId string 版本 id
versions.operateTime timestamp 版本操作时间
versions.operator string 版本操作人
versions.mark string 标记
versions.isOrigin boolean 是否起始版本
versions.isCurrent boolean 是否当前版本
versions.avatarUrl string 用户头像链接

备注

# 8 根据文档 id 下载图纸文件接口

简要描述

  • 下载指定文档对应的图纸文件。

请求 URL

  • /api/document/download

请求方式

  • GET

请求示例

  • api/document/download?docId=1533682221733515265

参数

参数名 必选 类型 说明
docId 是 long dwg 的文档 Id

返回示例*

二进制流文件

备注

# 9 格式转换接口

简要描述

  • dxf 和 dwg 互转

请求 URL

  • api/document/formatTransfer

请求方式

  • POST

请求示例

{
    "docIds": [
        1233,
        35446
    ],
    "type": "dwg",
    "dwgVersion": "2018",
    "toUpload": true,
    "uploadToFolderId": "123485736362",
    "plotSettings": {
        "plotType": 1,
        "minPoint": [
            0.0,
            0.0
        ],
        "maxPoint": [
            0.0,
            0.0
        ],
        "centered": "true",
        "fullScale": "true",
        "plotRotation": 0,
        "printPageId": "123456",
        "printStyleId": "12345"
    }
}

参数

参数名 必选 类型 说明
docIds 是 List docId 列表
type 是 string 要转换的目标格式，只能是 dxf、dwg、png、jpg、pdf
dwgVersion 是 string 版本包含：2018、2013、2010、2007、2004、2000、R14、R12，其中 R14 是 dwg 特有版本，R12 是 dxf 特有版本，其他的版本为两者共有。pdf、jpg、png 不需要设置该参数
toUpload 否 bool 是否上传到云端，默认为 false
uploadToFolderId 否 int64 需要上传至的文件夹 id
canvasWidth 否 int canvas 的宽
canvasHeight 否 int canvas 的高
plotSettings 否 object 打印相关配置（只有整体不传才会采用默认值，传入任意值后，其他参数将不再使用默认值，需要手动传入）
+plotType 是 int 打印方式 1:直接打印; 4:窗口打印，默认值 1
+minPoint 是 array 窗口打印左下角的点，只需要 x 和 y 值，默认值[0.0,0.0]
+maxPoint 是 array 窗口打印右上角的点，只需要 x 和 y 值，默认值[0.0,0.0]
+centered 是 boolean 是否为中心打印， true:是，false:否，默认值 true
+fullScale 否 boolean 是否布满图纸， true:是，false:否，默认值 true
+plotRotation 否 int 打印方向 0:纵向; 1:横向; 2:纵向+反向; 3:横向+反向，默认值 0
+pageIndex 否 int 标准纸张索引，例：63 表示 A4 纸，默认是 A4 纸张，默认值 63
+printPageId 否 string 自定义尺寸 id（pageIndex 和 printPageId 至少一个不为空，pageIndex 不为空时，以 pageIndex 设置的为准）
+denominator 否 double 自定义缩放比例分母
+printStyleId 否 string 打印样式 id，通过 上传打印样式接口 获取

返回示例*

  • 下载至本地的场合
二进制流文件
  • 上传至云端的场合
{
    "code": 0,
    "msg": success,
    "data": [
        {
            "docId": "123456788232",
            "name": "demo.dwg"
        }
    ]
}

返回参数说明

参数名 类型 说明
code int 状态码
msg string 状态消息
data array 数据对象
data[0].docId string 文档 Id
data[0].name string 文件名

备注

# 10 根据文件路径查找文件接口

简要描述

  • 根据 DWG 中的图片相对路径来查询图片的信息。图片文件存在多目录情况下，优先级：按时间倒序取，也就是最新的图片。用于图片类型外部参照场景。

请求 URL

  • /api/document/link

请求方式

  • POST

请求 Body

{
    "docId": "12321215456",
	"path": ".\folder1\sample1.png"
  }

参数

参数名 必选 类型 说明
docId 是 long dwg 的文档 Id
path 是 string 相对路径或者文件名

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": {
      "fileId": "123596989658965",
      "foundPath": "/folder1/sample1.png",
      "paramPath": ".\folder1\sample1.png",
    }
  }

返回参数说明

参数名 类型 说明
fileId long 文件 Id
foundPath string 查找到的文件路径
paramPath string 传入参数的文件路径

备注

# 11 查询文档信息列表（分页）接口

简要描述

  • 根据文件夹 id、关键字模糊搜索等查询条件分页查询文档信息列表。

请求 URL

  • /api/document/listPage

请求方式

  • GET

参数

参数名 必选 类型 说明
folderId 否 long 文件夹(0 表示根目录)
type 否 string 文档类型，枚举值：FOLDER，文件夹；DRAWING，图纸；IMAGE，图片；等
name 否 string 模糊查询关键字
pageNum 是 int 分页参数：页数（如：1,2,3 等）
pageSize 是 int 分页参数：每页包含数量（如：10,20,50 等）
orderByColumn 否 string 分页参数(后端排序字段)：排序字段，如 ownerId 等
isAsc 否 string 分页参数(后端排序升序或者降序)：只能是 asc 或 desc

请求示例

  • api/document/listPage?folderId=0&pageNum=1&pageSize=10&orderByColumn=type%20asc%2CupdateTime%20desc%2Cid&isAsc=desc&name=

返回示例*

{
    "msg": "success",
    "code": 0,
    "data": {
        "total": 488,
        "pageSize": 10,
        "pageNum": 1,
        "rows": [
            {
                "createBy": 2500,
                "createTime": 1704698019000,
                "updateBy": 2500,
                "updateTime": 1704698019000,
                "id": "1744256032068845569",
                "type": "DRAWING",
                "name": "Drawing2_1744256032135954432.dwg",
                "projectId": "1000",
                "folderId": "0",
                "sourceFileId": "1744256032068845568",
                "ownerId": 2500,
                "size": "62208",
                "delFlag": "NOT_DEL",
                "ownerName": "SDK超级用户",
                "transferResult": 2,
                "completePath": "/",
                "status": 0,
                "srcFileUpdateTime": 1704698019000
            },
            {
                "createBy": 2500,
                "createTime": 1704697866000,
                "updateBy": 2500,
                "updateTime": 1704697866000,
                "id": "1744255387806973953",
                "type": "DRAWING",
                "name": "Drawing2_1744255387970551808.dwg",
                "projectId": "1000",
                "folderId": "0",
                "sourceFileId": "1744255387806973952",
                "ownerId": 2500,
                "size": "62208",
                "delFlag": "NOT_DEL",
                "ownerName": "SDK超级用户",
                "transferResult": 2,
                "completePath": "/",
                "status": 0,
                "srcFileUpdateTime": 1704697866000
            },
            {
                "createBy": 2500,
                "createTime": 1704693974000,
                "updateBy": 2500,
                "updateTime": 1704693974000,
                "id": "1744239065828147201",
                "type": "DRAWING",
                "name": "AC-01-N02~N03(设计说明).dwg",
                "projectId": "1000",
                "folderId": "0",
                "sourceFileId": "1744239065828147200",
                "ownerId": 2500,
                "size": "1306063",
                "delFlag": "NOT_DEL",
                "ownerName": "SDK超级用户",
                "transferResult": 2,
                "completePath": "/",
                "status": 0,
                "srcFileUpdateTime": 1704693974000
            }
        ]
    }
}

返回参数说明

参数名 类型 说明
createBy int 创建者 ID
createTime long 创建时间
updateBy int 修改者 ID
updateTime long 修改时间
id long 文档 Id
type string 类型- FOLDER、DRAWING
name string 文档名称
sourceFileId int 文件 ID
ownerId int 所有者
size long 文件大小，单位：byte
delFlag string 文件状态
creator string 创建者名字
transferResult int 转换状态
completePath string 文档全路径
projectId string 项目 id
srcFileUpdateTime long 最后更新时间

备注

  • 1 平铺的数据返回，包含文档和文件夹，type 是 FOLDER 表示文件夹，DRAWING 表示图纸文件，FoderId 表示所属文件夹 ID，如果生成树状结构需要前端组装。

响应数据：

  • 2 除非特别标注，后续所有的基础分页参数都是 pageNum 和 pageSize，如果不传输分页参数，则会默认返回所有数据；
  • 3 swagger 页面不会显示分页接口的分页参数，前端使用分页接口时，只要加上分页参数即可。

# 12 查询文档信息列表接口

简要描述

  • 根据文件夹 id、关键字模糊搜索等查询条件查询文档信息列表。返回的数据结构与上述的分页查询接口有区别。

请求 URL

  • /api/document/list

请求方式

  • GET

参数

参数名 必选 类型 说明
folderId 否 long 文件夹(0 表示根目录)
type 否 string 文档类型，枚举值：FOLDER，文件夹；DRAWING，图纸；IMAGE，图片；等
name 否 string 模糊查询关键字
orderByColumn 否 string 分页参数(后端排序字段)：排序字段，如 ownerId 等
isAsc 否 string 分页参数(后端排序升序或者降序)：只能是 asc 或 desc

请求示例

  • api/document/list?type=DRAWING&name=Drawing

返回示例*

{
	"msg": "success",
	"code": 0,
	"data": [
		{
			"createBy": 2500,
			"createTime": 1704698019000,
			"updateBy": 2500,
			"updateTime": 1704698019000,
			"id": "1744256032068845569",
			"type": "DRAWING",
			"name": "Drawing2_1744256032135954432.dwg",
			"projectId": "1000",
			"folderId": "0",
			"sourceFileId": "1744256032068845568",
			"ownerId": 2500,
			"size": "62208",
			"delFlag": "NOT_DEL",
			"ownerName": "SDK超级用户",
			"transferResult": 2,
			"status": 0,
			"srcFileUpdateTime": 1704698019000
		},
		{
			"createBy": 2500,
			"createTime": 1704697994000,
			"updateBy": 2500,
			"updateTime": 1704697994000,
			"id": "1744255926682763265",
			"type": "DRAWING",
			"name": "Drawing2_1744255926854729728.dwg",
			"projectId": "1000",
			"folderId": "0",
			"sourceFileId": "1744255926682763264",
			"ownerId": 2500,
			"size": "62208",
			"delFlag": "NOT_DEL",
			"ownerName": "SDK超级用户",
			"transferResult": 2,
			"status": 0,
			"srcFileUpdateTime": 1704697994000
		}
	]
}

返回参数说明

参数名 类型 说明
createBy int 创建者 ID
createTime long 创建时间
updateBy int 修改者 ID
updateTime long 修改时间
id long 文档 Id
type string 类型- FOLDER、DRAWING
name string 文档名称
sourceFileId int 文件 ID
ownerId int 所有者
size long 文件大小，单位：byte
delFlag string 文件状态
creator string 创建者名字
transferResult int 转换状态
completePath string 文档全路径
projectId string 项目 id
srcFileUpdateTime long 最后更新时间

备注

# 13 根据多个文档 id 批量下载图纸文件接口

简要描述

  • 打包 zip 格式批量下载指定文档对应的图纸文件。目前只支持图纸文档打包下载。

请求 URL

  • /api/document/multiDownload

请求方式

  • POST

请求 Body

{
		"list":
			["1533682221733515265", "1533682157833293825"]
	}

参数

参数名 必选 类型 说明
list 是 long[] dwg 的文档 Id 列表

返回示例*

zip压缩文件文件流

返回参数说明

参数名 类型 说明

备注

# 14 根据文档 id 下载图纸文件，支持 http range 分段下载

简要描述

  • 根据 docId 分段下载文件，支持 http range 参数

请求 URL

  • /api/document/partDownload

请求方式

  • GET

Request Header 参数

参数名 必选 类型 说明
range 否 string 分段下载的参数，可以不传，不传时下载完整的文件，值的格式为 bytes={start}-{end},{start}从 0 开始，0 表示第一个 byte,例子：bytes=10000-20000 ,表示从 10000 个 byte 读取到第 20000 个 byte,{start}可以为空，例如：bytes=-20000,表示从第一个 byte 读取到 20000 个 byte,{end}可以为空，例如 bytes=10000-,表示读取 10000 个 byte 开始后面所有的数据

参数

参数名 必选 类型 说明
docId 否 string 要下载的文档 id
fileId 是 string 要下载的 fileId

Response Header 参数说明

参数名 类型 说明
content-range string 返回的 content-range 参数，格式：bytes {range}/{size} ,例子 bytes 1000-2000/12000,其中{range}为 request 传入的参数{start-end},{size}为下载的文件总的大小
content-length int 下载的分段文件的大小，例如 1000，即为起始值和初始值的差值

备注

为分段下载时，http 状态码返回 206，表示为分段数据

# 15 分页查询回收站列表

简要描述

  • 获取回收站列表。
参数名 必选 类型 说明
pageNum 否 int 页码
pageSize 否 int 页数

请求 URL

  • /api/document/recycle

请求方式

  • GET

请求示例

  • api/document/recycle?pageNum=1&pageSize=10

返回示例*

{
  	"msg":"操作成功",
	"code":0,
	"data":{
		"total":1,
		"pageSize": 10,
		"pageNum": 1,
		"rows":[{
			"createBy":1,
			"createTime":"2022-06-27T12:25:58.000+08:00",
			"updateBy":1,
			"updateTime":"2022-06-27T12:25:59.000+08:00",
			"id":"1540254634210365441",
			"type":"DRAWING",
			"name":"三视口上.dwg",
			"sourceFileId": 123,
			"srcFileUpdateTime": 234,
			"projectId":"0",
			"folderId":"0",
			"status": 0,
			"ownerId":1,
			"size":39437,
			"delFlag":"DEL_RECYCLE",
			"ownerName": "demo",
			"completePath":"/"
		}]}}

返回参数说明

参数名 类型 说明
code int 状态码
msg string 返回消息
data array 对象数组
createBy int 创建人 id
createTime int 创建时间
updateBy int 更新人
updateTime int 更新时间
id int 文档 id
type string 文档类型
name string 文档名称
projectId long 项目 id
folderId long 文件夹 id
ownerId int 所有者 id
size int 文件大小，单位：byte
sourceFileId long 源文件 id
srcFileUpdateTime int 源文件更新时间
delFlag string 删除标识
ownerName string 所有者名称
completePath string 完整路径

备注

# 16 批量恢复回收站内的文件

简要描述

  • 从回收站列表中恢复被删除的文件。

请求 URL

  • /api/document/recycle

请求方式

  • POST

请求 Body

{
    "ids": ["12321215456"]
  }

参数

参数名 必选 类型 说明
ids 是 long dwg 的文档 Id 列表

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": true
  }

返回参数说明

参数名 类型 说明

备注

# 17 批量删除回收站内的文件

简要描述

  • 从回收站列表中彻底删除文件。

请求 URL

  • /api/document/recycle

请求方式

  • DELETE

请求 Body

{
    "ids": ["12321215456"]
  }

参数

参数名 必选 类型 说明
ids 是 long dwg 的文档 Id 列表

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": true
  }

返回参数说明

参数名 类型 说明
fileId long 文件 Id
foundPath string 查找到的文件路径
paramPath string 传入参数的文件路径

备注

# 18 查询文档转换状态

简要描述

  • 当 DWG 文件上传后会进入转换中的状态，获取当前文档转换状态信息。

请求 URL

  • /api/document/transferstatus

请求方式

  • GET

请求示例

  • /api/document/transferstatus?id=15233685336536523563

参数

参数名 必选 类型 说明
id 是 long dwg 的文档 Id

返回示例*

{
    "msg": "操作成功",
	"code": 0,
    "data": {
      "fileId": "123596989658965",
      "name": "12353365336536.lmf",
      "status": 2,
	  "failedReason": null
    }
  }

返回参数说明

参数名 类型 说明
fileId long lmf 文件 id
name string 转换后的文件名
status int 转换后的状态,1:转换中，2：转换成功，3：转换失败
failedReason string 转换失败后的原因

备注

# 19 文档上传

简要描述

  • 文件上传(支持 DWG、DXF 以及 PNG、BMP、JPG、JPEG、GIF、TIF、TIFF、PCX、TGA、ECW、JP2、J2K、CAL 图片等文件)， 并支持 PNG、BMP、JPG、JPEG 和 GIF 文件作为参照嵌入到图纸内查看

请求 URL

  • /api/document/upload

请求方式

  • POST

参数

  • Body FormData
参数名 必选 类型 说明
file 是 filestream 请求头的 content-type 必须是 multipart/form data
folderId 是 long 文件夹(根目录的 ID 为 0)

返回示例*

{
    "msg": "success",
    "code": 0,
    "data": {
        "docId": "1744298810983301121",
        "name": "Drawing-五视口_1744298811172044800.dwg",
        "id": "1744298810983301120"
    }
}

返回参数说明

参数名 类型 说明
docId string 文档 Id
name string 文档名称
id string 文档源文件 id

备注

# 20 开图获取文档详细信息接口

简要描述

  • 开图获取文档详细信息接口，性能较好。

请求 URL

  • /api/document/view/detail

请求方式

  • GET

请求示例

/api/document/view/detail?id=1749344237187178496

参数

参数名 必选 类型 说明
id 是 string 文档 Id

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "id": "1749344237187178496",
        "type": "DRAWING",
        "name": "19幢房产分户图.dwg",
        "projectId": "1742366089172205568",
        "folderId": "0",
        "size": "2914858",
        "delFlag": "NOT_DEL",
        "layouts": [
            {
                "createBy": 2135,
                "createTime": 1705911147000,
                "updateTime": 1705911147000,
                "docId": "1749344237187178496",
                "handleId": "579",
                "name": "模型",
                "tabOrder": 0,
                "isDefault": "YES",
                "lmfFileId": "1749344258620071936",
                "lmfFileName": "layout_default.lmf",
                "lmfFileSize": "1435210",
                "transferResult": "SUCCESS"
            },
            {
                "createBy": 2135,
                "createTime": 1705911147000,
                "docId": "1749344237187178496",
                "handleId": "580",
                "name": "Layout1",
                "tabOrder": 1,
                "isDefault": "NO"
            }
        ],
        "fonts": [
            {
                "fileId": "1000005",
                "name": "simsun.ttf"
            }
        ],
        "status": 0,
        "srcFileUpdateTime": 1705911142000
    }
}

返回参数说明

参数名 类型 说明
createBy int 创建人 id
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 文件大小，单位：byte
delFlag string 删除标识
completePath string 文档全路径
layouts array 文档 layout 信息列表
layouts.createBy int 转换人 id
layouts.createTime timestamp 转换时间戳
layouts.docId string 文档 id
layouts.handleId string 文档 layout 的 handleId，layout 的唯一标记
layouts.name string 文档 layout 的名称
layouts.tabOrder string 文档 layout 的顺序，从 0 开始
layouts.isDefault string 是否是默认 layout：“YES”，是；“NO”：否；
layouts.lmfFileId string 文档 layou 对应的显示数据文件的 id
layouts.transferResult string 文档 layou 对应的转换结果：“SUCCESS”，成功；“FAIL”，失败；“IN_PROGRESS”，处理中；“QUEUE”，排队中；“OTHER”，其它；
fonts array 文档中用到的并且文档所在项目中拥有的字体列表
fonts.name string 字体名称
fonts.fileId string 字体 id

备注

# 21 批量打印

简要描述

  • 默认设置下，批量打印文档。

请求 URL

  • /api/document/batchPrint

请求方式

  • POST

请求示例

/api/document/batchPrint body 中以 json 格式传参

{
  "docId": "1749371465455312897",
  "handleId": "579",
  "layers": [],
  "filename": "19幢房产分户图-模型",
  "plotBlocks": [],
  "ptType": 0,
  "plotSettings": {
    "pageIndex": 63,
    "centered": true,
    "fullScale": true,
    "denominator": 1,
    "xCoordinate": 0,
    "yCoordinate": 0
  },
  "plotImageAutoFit": 0,
  "plotImageWidth": 0,
  "lineWeights": true,
  "plotToMultiPDF": 0,
  "frameOrder": 1,
  "isFrameReserve": 0,
  "frameMode": 1
}

参数

参数名 必选 类型 说明
docId 是 string 文档 Id
handleId 是 string 文档 layout id，可以从文档详情接口中获取（接口 7 和接口 20）
layers 是 array 图层 layerId 列表，默认情况下请传值为空数组，参见上面的请求示例
filename 是 string 打印出来的默认文件名，建议为“文档名-layout 名称”，参见上面的请求示例
ptType 是 int 输出文件类型：0，pdf；1，odf；2，png；3，jpg；
plotImageAutoFit 否 int 图片打印是否自适应:0,不自适应;1,自适应。默认为 0
plotImageWidth 否 int 图片打印宽度，plotImageAutoFit 为 1 的场合生效
lineWeights 是 boolean 是否打印线宽，建议设置为 true
plotToMultiPDF 否 int 是否生成多页 pdf，0 表示不生成，1 表示生成 ，0 的场合会生成多个单页 pdf 文件，并以压缩包的格式返回二进制数据流，1 的场合返回单个多页 pdf 文件文件流
frameMode 是 int 打印模式，0 为图层，1 为图块，2 为散线，3 为整个文件
isFrameReserve 否 int 图形是否反转，默认为 0，即不反转，为 1 时反转
plotSettings 是 object 打印相关配置，内容不固定。默认可以设置为{ "pageIndex": 63, "centered": true, "fullScale": true, "denominator": 1, "xCoordinate": 0, "yCoordinate": 0 }
pageIndex 是 int 纸张配置索引，对应各种尺寸的打印纸张，如：55，ISO A2（594.00 x 420.00 MM);56，ISO A5（420.00 x 594.00 MM）;59，ISO A3 (420.00 x 297.00 MM);60，ISO A3 (297.00 X 420.00 MM)；63，ISO A4 (297.00 x 210.00 MM)； 64，ISO A4 (210.00 x 297.00 MM)等；
centered 是 boolean 是否为中心打印：true，是；false，否；
fullScale 是 boolean 是否铺满纸张：true，是；false，否；
denominator 是 int fullScale 为 false 时配置该属性，表示打印比例为 1:denominator
xCoordinate 是 int 打印原点偏移，x 轴坐标。centered 为 false 时配置 xCoordinate 和 yCoordinate
yCoordinate 是 int 打印原点偏移，y 轴坐标。centered 为 false 时配置 xCoordinate 和 yCoordinate

返回示例*

打印产生的文件流

返回参数说明

接口返回打印产生的 pdf 文件或者 png 等文件的文件流，可以另存为文件

备注

# 22 文档复制

简要描述

复制文档

请求 URL

  • /api/document/copy

请求方式

  • POST

请求示例

/api/document/copy

{
    "list":["1763566647961923584"],
    "id":"0",
    "projectId":"1000",
    "operationId":"1764915204954468352"
}

参数（application/json）

参数名 必选 类型 说明
list 是 array 需要复制的文档 Id
id 是 string 目标文件夹 ID，SDK 默认文件夹为 0，根文件夹
projectId 是 string SDK 默认项目 id 是 1000
operationId 是 string 操作标识 id, 从 project/space 接口中获取 uploadId

返回示例*

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "conflictList": [],
        "docId": {
            "1763566647961923584": "1764915205302595584"
        },
        "count": 1,
        "conflict": false
    }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
conflictList array 重名冲突文件的列表
docId map key 为复制前的文档 id，value 为复制后的文档 id
count int 成功复制的数量
conflict boolean 表示是否没有文档名称重复数据，true 表示有重复，false 表示没有重复

备注

# 23 获取项目空间操作事件 id

简要描述

获取项目空间操作事件 id

请求 URL

  • /api/project/space

请求方式

  • POST

请求示例

{
    "projectId": "1000"
}

参数（application/json）

参数名 必选 类型 说明
projectId 是 string 关联项目 id

返回示例*

{
"code":0,
"msg":"操作成功",
"data":
    {
        "uploadId":"1764915204954468352"
    }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
uploadId string 复制事件标识

备注

# 24 文档评论列表

简要描述

分页查询文档评论列表，支持按评论时间、评论人和关键字筛选

请求 URL

  • /api/doc/comment/listPage

请求方式

  • GET

请求示例

  • /api/doc/comment/listPage?docId=15233685336536523563

参数

参数名 必选 类型 说明
docId 是 Long 文档 ID
handleId 是 Long 布局 ID
keyword 否 String 评论关键字搜索
userIds 否 List 评论人用户 ID 列表
startTime 否 String 开始时间，格式如：2024-03-08 13:49:00
endTime 否 String 结束时间，格式如：2024-03-08 13:49:00
pageNum 是 Integer 第几页
pageSize 是 Integer 每页展示数量
orderByColumn 否 String 支持的排序参数： createTime
isAsc 否 String desc:降序，asc:升序

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "total": 1,
        "pageSize": 40,
        "pageNum": 1,
        "rows": [
            {
                "createBy": 40661,
                "creator": "张三",
                "createTime": 1710147784000,
                "updateBy": 40661,
                "updateTime": 1710148008000,
                "id": "1767114002452176896",
                "docId": "1766016753252950016",
                "handleId": "34",
                "parentId": "0",
                "level": 0,
                "withAt": "NO",
                "withMark": "NO",
                "atUserIds": "",
                "content": "test%7B%7D",
                "mark": "",
                "replyList": [
                    {
                        "createBy": 40661,
                        "creator": "李四",
                        "createTime": 1710148016000,
                        "id": "1767114974855421952",
                        "docId": "1766016753252950016",
                        "handleId": "34",
                        "parentId": "1767114002452176896",
                        "level": 1,
                        "withAt": "NO",
                        "withMark": "NO",
                        "content": "123%7B%7D"
                    }
                ]
            }
        ]
    }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
total long 总数
pageNum Integer 第几页
pageSize Integer 每页展示数量
rows List 数据列表
id string 评论 ID
docId string 文档 ID
handleId string 布局 ID
parentId string 父级评论 ID
level int 层级关系，根评论为 0，子评论为父级评论加 1
withAt string 是否存在@用户，YES:存在，NO:不存在
withMark string 是否存在标记，YES:存在，NO:不存在
atUserIds string 评论中@的用户 ID，多个用户以逗号分割
atUserIds string 评论中@的用户 ID，多个用户以逗号分割
content string 评论内容，其中$为@用户的占位符，#为标记的占位符，评论结尾的大括号包含了@用户 ID 列表，通过逗号分割，形式如：{1,2,3}，{-1}表示@全部，整个 content 字符串通过 URLEncoder.encode UTF-8 编码后返回，建议反向解码处理后展示
mark string 评论中的标记数据
avatarUrl string 用户头像 url
replyList List 回复的评论，内部结构字段和父评论一致

备注

# 25 获取项目下的成员列表

简要描述

查询指定项目下的成员列表，支持关键字搜索、分页查询和获取全量数据

请求 URL

  • /api/team/pageProjectMembers

请求方式

  • GET

请求示例

  • /api/team/pageProjectMembers?projectId=17633685336536523563

参数

参数名 必选 类型 说明
projectId 是 string 项目 id
pageNum 否 Integer 第几页，isPage=true 时生效
pageSize 否 Integer 每页展示数量,isPage=true 时生效
isPage 是 boolean 是否分页，true:分页，false:返回全量数据
queryType 是 string 查询类型，USER:查询项目下用户列表，TEAM:查询项目下的团队内的用户列表
teamId 否 string 团队 Id,queryType=TEAM 时需要传

返回示例*

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "total": 1,
        "pageSize": 999999,
        "pageNum": 1,
        "rows": [
            {
                "memberId": "40659",
                "email": "zhangsan@163.com",
                "memberName": "张三",
                "memberType": "USER",
                "lastTime": 1710149185000,
                "roleId": "1766016449031692291",
                "roleName": "查看者",
                "color": "#87CEFA"
            }
        ]
    }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
total long 总数
pageNum Integer 第几页
pageSize Integer 每页展示数量
rows List 数据列表
memberId int 用户 ID
email string 用户邮箱
memberName string 用户名称
memberType string 成员类型，USER:用户，TEAM:团队，PROJECT_ADMIN:项目管理员
lastTime long 最近一次登录时间，返回毫秒
roleId string 用户在项目中的角色 ID
roleName string 角色名称
color string 颜色

备注

# 26 上传图纸并自动转换（SDK 专用）

简要描述

上传图纸并自动转换，SDK 下使用

请求 URL

  • /api/file/upload

请求方式

  • POST

请求示例

  • 二进制文件的场合
file:(二进制)
folderId:0
  • 文件路径的场合
folderId: 0
fileName: drawing/test.dwg

参数（form-data）

参数名 必选 类型 说明
file 否 binary 文件二进制数据，fileName 为空的场合必传
folderId 是 int 文件夹 id，SDK 场景下默认为根目录 0
fileName 否 string 文件在服务器上的相对路径，file 为空的场合必传

返回示例*

{
"code":0,
"msg":"操作成功",
"data":
    {
        "docId":"1776856440984698881",
        "name": "文件名"
    }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
docId string 文档 id
name string 文档名称

备注

# 27 获取电子签名、签章签署记录列表

简要描述

获取电子签名、签章签署记录列表

请求 URL

  • /api/sign/signRecords

请求方式

  • GET

请求示例

/api/sign/signRecords?dwgPath=123.dwg

参数（form-data）

参数名 必选 类型 说明
dwgPath 是 string sdk 下默认为 docId + 上传文件后缀名

返回示例*

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "blockData": [
                {
                    "refData": [
                        {
                            "signId": "123456789",
                            "attrInsertPoint": "",
                            "attrUvector": "",
                            "attrVvector": "",
                            "attrHandle": "575",
                            "attrName": "项目负责人_机打信息",
                            "attrValue": "张三",
                            "signFileId": "",
                            "certFileId": "",
                            "type": 1,
                            "signTime": "时间戳"
                        }
                    ],
                    "refInsertPoint": "",
                    "refUvector": "",
                    "refVvector": "",
                    "refHandle": "574"
                }
            ]
        }
    ]
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg int 返回消息
data object 数据对象
data.blockData.refHandle 属性块 handleid
data.blockData.refVvector string 属性块纵向矢量
data.blockData.refInsertPoint string 属性块插入点
data.blockData.refUvector string 属性块横向矢量
data.blockData.refData.attrHandle int 属性 handle
data.blockData.refData.attrUvector string 属性横向矢量
data.blockData.refData.attrInsertPoint string 属性插入点
data.blockData.refData.attrVvector string 属性纵向矢量
data.blockData.refData.attrName string 属性名
data.blockData.refData.attrValue string 属性值
data.blockData.refData.signFileId string 签名，签章图片文件 id
data.blockData.refData.caFileId string 签章图片 CA 证书文件 id
data.blockData.refData.signDateTime datetime 签署时间戳
data.blockData.refData.signDateTime int type 类型

备注

# 28 获取文档外部参照列表

简要描述

获取文档外部参照列表

请求 URL

  • /api/document/xref

请求方式

  • GET

请求示例

/api/document/xref/1776857611497504769

参数（path-variable）

参数名 必选 类型 说明
[path variable] 是 string 文档 id

返回示例*

{
    "msg": "操作成功",
    "code": 0,
    "data": [
        {
            "name": "百合花",
            "xrefStatus": "FILE_NOT_FOUND",
            "status": "LOADED",
            "size": 1957457,
            "suffix": "DWG",
            "createTime": "2022-05-07 18:41:25",
            "foundPath": "\\测试新增\\百合花.dwg",
            "refPath": "./百合花.dwg",
            "refDocId": "15656129555488745474",
            "fileId": "1568512555444525",
            "list:"[
                {
                    "name": "菊花",
                    "xrefStatus": "FILE_NOT_FOUND",
                    "status": "LOADED",
                    "size": 195651257,
                    "suffix": "DWG",
                    "createTime": "2022-05-07 18:41:25",
                    "foundPath": "\\测试新增\\菊花.dwg",
                    "refPath": "./菊花.dwg",
                    "refDocId": "15656129555545151875",
                    "fileId": "156851262345",
                    "list:"[]
                }
            ]
        }
    ]
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
name string 找到的参照文档的名称
xrefStatus string C++返回的图纸内嵌参照状态
status string 文档参照状态
size string 找到的参照文档的大小
suffix string 找到的参照文档的后缀
createTime string 找到的参照文档的创建时间
foundPath string 找到的参照文档的数据库虚拟路径
refPath string 文档内部参照路径
refDocId string 找到的参照文档的 id
fileId string 找到的参照文档的缩略图文件 id 或源文件 id
list list 找到的参照文档的外部参照列表，即嵌套参照

备注

# 29 获取文档图块列表

简要描述

获取文档图块列表

请求 URL

  • /api/document/fetchBlockList

请求方式

  • GET

请求示例

/api/document/fetchBlockList?docId=1776857611497504769

参数（form-data）

参数名 必选 类型 说明
docId 是 string 文档 id

返回示例*

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        "block1",
        "block2"
    ]
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data array 图块列表

备注

# 30 切换 layout

简要描述

切换 layout

请求 URL

  • /api/layout/lmf

请求方式

  • GET

请求示例

/api/layout/lmf?handleId=456&docId=1776857611497504769

参数（form-data）

参数名 必选 类型 说明
handleId 是 string 句柄 id
docId 是 string 文档 id

返回示例*

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "lmfId": "1776866662646153216",
        "transferResult": 0,
        "lmfFileName": "布局1",
        "updateTime": 1712472999623
    }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
lmfId string 显示数据文件 id
transferResult int 转换结果，0 表示待转换，后续使用“/api/file/info”（详见文件管理页面）接口轮询转换结果
lmfFileName string lmf 文件名
updateTime int64 更新更新戳（毫秒）

备注

# 31 获取图纸缩略图

简要描述

获取图纸缩略图

请求 URL

  • /api/file/thumbnail/{docId}

请求方式

  • GET

请求示例

/api/file/thumbnail/1776857611497504769

参数（path variable）

参数名 必选 类型 说明
docId 是 string 文档 id

返回示例*

二进制流

备注

# 32 重生成

简要描述

重生成图纸对应的显示数据

请求 URL

  • /api/file/transfer

请求方式

  • POST

请求示例

/api/file/transfer?docId=1345

参数（query string）

参数名 必选 类型 说明
docId 是 string 文档 id

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": true
}

备注

# 33 新增自定义打印尺寸

简要描述

新增自定义打印尺寸

请求 URL

  • /api/printPage/add

请求方式

  • POST

请求 Body

参数名 必选 类型 说明
name 是 string 自定义打印尺寸名称
width 是 double 宽
height 是 double 高
unit 是 string 尺寸单位，millimeter(毫米)，inches(英尺)，pixels(像素：打印类型为图片（jpg 和 png）时生效，不支持设置页边距)
hidden 否 int 是否隐藏，0：不隐藏，1：隐藏，默认不隐藏
top 否 double 页边距（上），不传默认为 0
bottom 否 double 页边距（下），不传默认为 0
left 否 double 页边距（左），不传默认为 0
right 否 double 页边距（右），不传默认为 0

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": true
}

备注

# 34 修改自定义打印尺寸

简要描述

修改自定义打印尺寸

请求 URL

  • /api/printPage/update

请求方式

  • POST

请求 Body

参数名 必选 类型 说明
id 是 Long 尺寸唯一标识
name 是 string 自定义打印尺寸名称
width 是 double 宽
height 是 double 高
unit 是 string 尺寸单位，millimeter(毫米)，inches(英尺)，pixels(像素：打印类型为图片（jpg 和 png）时生效，不支持设置页边距)
hidden 否 int 是否隐藏，0：不隐藏，1：隐藏，默认不隐藏
top 否 double 页边距（上），不传默认为 0
bottom 否 double 页边距（下），不传默认为 0
left 否 double 页边距（左），不传默认为 0
right 否 double 页边距（右），不传默认为 0

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": true
}

备注

# 35 删除自定义打印尺寸

简要描述

删除自定义打印尺寸

请求 URL

  • /api/printPage/delete

请求方式

  • POST

请求 Body

参数名 必选 类型 说明
ids 是 Long 需要删除的尺寸唯一标识集合

请求示例

[1234,2345,4567]

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": true
}

备注

# 36 查询自定义打印尺寸列表

简要描述

查询所有的自定义打印尺寸列表

请求 URL

  • /api/printPage/list

请求方式

  • GET

请求参数

无

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
id Long 尺寸唯一标识
name string 自定义打印尺寸名称
width double 宽
height double 高
unit string 尺寸单位，millimeter(毫米)，inches(英尺)，pixels(像素)
hidden int 是否隐藏，0：不隐藏，1：隐藏
top double 页边距（上）
bottom double 页边距（下）
left double 页边距（左）
right double 页边距（右）

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": 1234,
                "hidden": 0,
                "name": "自定义打印尺寸1",
                "width": 1700.0,
                "height": 900.0,
                "unit": "millimeter",
                "top": 7.0,
                "bottom": 7.0,
                "left": 7.0,
                "right": 7.0
            }
        ]
    }
}

备注

# 37 获取上传唯一标识

简要描述

获取上传唯一标识

请求 URL

  • /api/project/space

请求方式

  • POST

请求 Body

参数名 必选 类型 说明
fileId 是 String 本次上传的文件唯一 id（生成随机字符串即可）
size 是 int 本次上传的文件大小（单位：字节）

请求示例

{
    "files":[
        {
            "fileId":"123456",
            "size":4106
        }
    ]
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
allowed boolean 是否允许上传
uploadId string 上传唯一标识

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "allowed": true,
        "uploadId": "1813890996610478080"
    }
}

备注

# 38 上传打印样式文件

简要描述

上传打印样式文件，调用此接口前需要调用接口 <37 获取上传唯一标识>,获取 uploadId

请求 URL

  • /api/project/printStyle/upload

请求方式

  • POST

FormData 请求参数

参数名 必选 类型 说明
file 是 File 打印样式文件
uploadId 是 string 获取上传标识接口返回的 uploadId
id 是 String 获取上传标识接口，请求参数中的自定义生成的 fileId
projectId 是 long sdk 模式需要传 1000

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
id boolean 打印样式文件 ID
name string 文件名称
size int 文件大小

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "id": "1813891510068785152",
        "name": "zwcad.ctb",
        "size": 4106
    }
}

备注

# 39 删除打印样式文件

简要描述

删除上传的打印样式文件

请求 URL

  • /api/project/printStyle/delete

请求方式

  • POST

请求 Body

参数名 必选 类型 说明
ids 是 array 打印样式文件 id 列表

请求示例

{
    "ids":[1813891510068785152,1845891510068785897]
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": ""
}

备注

# 40 分页查询打印样式文件列表

简要描述

查询打印样式文件列表

请求 URL

  • /api/project/printStyle/listPage

请求方式

  • GET

请求参数

参数名 必选 类型 说明
projectId 是 long sdk 模式需要传 1000
pageNum 否 int 默认值为 1
pageSize 否 int 默认值为 10

请求示例

/api/project/printStyle/listPage?projectId=1000&pageNum=1&pageSize=20

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
total int 数据总数
pageNum int 页码
pageSize int 每页展示数量
rows array 列表数据
id string 打印样式 id
name array 打印样式文件名称
createTime array 创建时间
size array 文件大小（单位：字节）

返回示例*

{
    "code": 0,
    "msg": "success",
    "data": {
        "total": 1,
        "pageSize": 10,
        "pageNum": 1,
        "rows": [
            {
                "id": "1812728218948984832",
                "name": "hatch相关.ctb",
                "createTime": 1721023061000,
                "size": 4243
            }
        ]
    }
}

备注

# 41 图纸打印

简要描述

打印指定图纸

请求 URL

  • /api/document/print

请求方式

  • POST

请求参数

参数名 必选 类型 说明
docId 是 string 文档 id
handleId 是 string 句柄 id
lineWeights 是 bool
canvasWidth 是 int canvas 的宽度
canvasHeight 是 int canvas 的高度
plotLayers 否 object 设置需要打印的打印
plotLayers[0].layerId 否 string 图层的句柄 id
plotLayers[0].isPlottable 否 int 是否打印图层，0 为不打印；1 为打印
ptType 是 int 打印类型
plotSettings 是 object 打印设置
plotSettings[0].centered 否 bool 是否居中打印
plotSettings[0].xCoordinate 是 int x 轴方向偏移，默认传 0
plotSettings[0].yCoordinate 是 int y 轴方向偏移，默认传 0
plotSettings[0].denominator 是 int 自定义缩放比例，默认为 1
plotSettings[0].fullScale 是 bool 是否布满图纸
plotSettings[0].plotType 是 int 打印方式，0 为显示打印，1 为范围打印，4 为窗口打印
plotSettings[0].pageIndex 是 int 纸张配置索引
plotSettings[0].plotRotation 是 int 打印方向，0 为纵向，1 为横向
plotSettings[0].maxPoint 是 array 最大点空间坐标
plotSettings[0].minPoint 是 array 最小点空间坐标
openElecSignSeal 否 int 是否携带用户电子签章，0 为否，1 为是
openEnterpriseSign 否 int 是否携带企业电子签章，0 为否，1 为是

请求示例

{
    "docId": "1813039547697541120",
    "handleId": "34",
    "ptType": 0,
    "plotLayers": [
        {
            "layerId": "16",
            "isPlottable": 1
        }
    ],
    "plotSettings": {
        "plotType": 1,
        "minPoint": [
            0,
            0,
            0
        ],
        "maxPoint": [
            0,
            0,
            0
        ],
        "centered": true,
        "fullScale": true,
        "denominator": 1,
        "plotRotation": 1,
        "pageIndex": 63,
        "xCoordinate": 0,
        "yCoordinate": 0
    },
    "canvasWidth": "1098",
    "canvasHeight": "497",
    "lineWeights": true,
    "openElecSignSeal": 0,
    "openEnterpriseSign": 0
}

返回参数说明

二进制文件流

备注

# 42 外部文件系统关联 id 推送

简要描述

  • 用户指定外部文件系统关联 id 和外部下载地址，推送到 CAD 看图系统

请求 URL

  • /api/external/document/push

请求方式

  • POST

参数（application/json）

参数名 必选 类型 说明
projectId 否 string 文档归属项目
folderId 否 string 文档归属文件夹 id
externalId 是 string 外部文件系统关联 id
name 否 string 关联文档名称 ，不传的场合使用 docId 命名
needUpdate 否 bool 是否强制更新 ，默认为 false
externalFileUrl 是 string 外部文件系统下载链接

请求示例

{
    "externalId": "123-qwe",
    "needUpdate": true,
    "externalFileUrl": "http://fileserver.com/test.dwg"
}

返回示例*

{
  "code": 0,
  "msg": "success",
  "docId": "123456789"
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data string 数据对象
docId string 文档 id

备注

# 43 获取图纸分享链接

简要描述

  • 获取指定图纸的分享链接（目前只支持 dwg/dxf/dwf 类型文档分享）

请求 URL

  • /api/share/link

请求方式

  • GET

请求参数

参数名 必选 类型 说明
docId 是 string 图纸 Id

请求示例

  • /api/share/link?docId=1874639875795042305

返回示例*

# 该文档还未被分享：

{
  "code": 0,
  "data": "",
  "msg": "操作成功"
}

# 该文档已被分享：

{
  "code": 0,
  "msg": "操作成功",
  "data": {
    "docId": "1874639875795042305",
    "docName": "赵十明_1874639876206084096.dwg",
    "owner": "SDK超级用户",
    "belongProject": "SDK默认管理项目",
    "shareId": "1874640103189233664",
    "createTime": 1735783950000,
    "shareTime": 1735784004000,
    "updateTime": 1735783950000,
    "expireTime": 1735870404000,
    "password": "4YRU",
    "shareScope": "ANY",
    "timeLimit": "ONE_DAY",
    "link": "http://192.168.56.176/share/view/coD2crzQe28",
    "size": "148204",
    "type": ".dwg",
    "path": "/",
    "isAnon": "YES",
    "hasPerm": "YES",
    "valid": "YES",
    "status": "NORMAL"
  }
}

返回参数说明

参数名 类型 说明
code int 状态码
msg string 返回消息
data string 数据对象
docId string 文档 id
docName string 文档名称
belongProject string 文档所属项目
shareId string 文档的分享 id
createTime number 文档创建时间
shareTime number 分享创建时间
updateTime number 分享更新时间
expireTime number 分享过期时间
password string 分享密码（无该参数返回时无密码）
shareScope string 分享范围（暂只支持所有人"ANY"）
timeLimit string 分享时间限制（1 分钟：ONE_MINUTE；1 天：ONE_DAY；1 周：ONE_WEEK；1 个月：ONE_MONTH；永久：UNLIMIT）
link string 文档分享链接
size string 文档大小（字节）
type string 文档类型（目前只支持 dwg/dxf/dwf 类型文档分享）
path string 文档相对路径

备注

# 44 创建图纸分享链接

简要描述

  • 为指定图纸创建分享链接（目前只支持 dwg/dxf/dwf 类型文档分享）

请求 URL

  • /api/share/link

请求方式

  • POST

参数（application/json）

参数名 必选 类型 说明
docId 是 string 文档 Id
isAnon 是 string 是否为匿名分享（SDK 均为匿名分享）
shareScope 是 string 分享范围（暂只支持所有人"ANY"）
timeLimit 是 string 分享时间限制（1 分钟：ONE_MINUTE；1 天：ONE_DAY；1 周：ONE_WEEK；1 个月：ONE_MONTH；永久：UNLIMIT）
usePassword 是 string 是否添加分享密码
password 否 string 当有分享密码时为必填，密码格式为 4 位的数字/字母组合

请求示例

{
  "docId": "1874639875795042305",
  "isAnon": "YES",
  "shareScope": "ANY",
  "timeLimit": "ONE_DAY",
  "usePassword": "YES",
  "password": "4YRU"
}

返回示例*

{
  "code": 0,
  "msg": "操作成功",
  "data": {
    "shareId": "1874640103189233664",
    "link": "http://192.168.56.176/share/view/coD2crzQe28"
  }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data string 数据对象
shareId string 文档分享 id
link string 文档分享链接

备注

# 45 取消图纸链接分享

简要描述

  • 取消指定图纸的分享链接

请求 URL

  • /api/share/link/cancel

请求方式

  • POST

参数（application/json）

参数名 必选 类型 说明
ids 是 string 数组 需要取消分享的所有文档的 shareId

请求示例

{
  "ids": ["1874640103189233664"]
}

返回示例*

{
  "code": 0,
  "msg": "操作成功",
  "data": true
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data string 数据对象

备注

# 46 重置图纸链接分享

简要描述

  • 重置指定图纸的分享链接及分享密码

请求 URL

  • /api/share/link/reset

请求方式

  • POST

参数（application/json）

参数名 必选 类型 说明
ids 是 string 需要取消分享的文档的 shareId

请求示例

{
  "shareId": "1874641196006752256"
}

返回示例*

{
  "code": 0,
  "msg": "操作成功",
  "data": {
    "shareId": "1874715097084706816",
    "link": "http://192.168.56.176/share/view/coEnuKLS1nw",
    "password": "alHH"
  }
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data string 数据对象
shareId string 文档分享 id
link string 文档分享链接
password string 分享链接密码（若无分享密码则无该参数返回）

备注

# 47 更新图纸分享链接

简要描述

  • 更新指定图纸的分享链接的相关参数

请求 URL

  • /api/share/link/update

请求方式

  • POST

参数（application/json）

参数名 必选 类型 说明
shareId 是 string 文档分享 id
isAnon 是 string 是否为匿名分享（SDK 均为匿名分享）
shareScope 是 string 分享范围（暂只支持所有人"ANY"）
timeLimit 是 string 分享时间限制（1 分钟：ONE_MINUTE；1 天：ONE_DAY；1 周：ONE_WEEK；1 个月：ONE_MONTH；永久：UNLIMIT）
usePassword 是 string 是否添加分享密码
password 否 string 当有分享密码时为必填，密码格式为 4 位的数字/字母组合

请求示例

{
  "shareId": "1874639875795042305",
  "isAnon": "YES",
  "shareScope": "ANY",
  "timeLimit": "ONE_DAY",
  "usePassword": "YES",
  "password": "4YRU"
}

返回示例*

{
  "code": 0,
  "msg": "操作成功",
  "data": true
}

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data string 数据对象

备注

字体管理