外观
上传图纸
接口概述
上传单张图纸(DWG)或结构计算书文件。上传成功后返回文件信息,需将返回结果收集为数组,再调用上传图纸完成并开启预审完成提交。
本接口单个文件请求,如需上传多张图纸,需要多次调用并将返回值汇总。
请求地址
http
POST /uploadDrawing请求头
| 参数 | 必填 | 说明 |
|---|---|---|
| apiKey | 是 | API 访问凭证 |
| Platform | 是 | 平台标识,取值参见快速开始 |
| Content-Type | 是 | multipart/form-data |
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| file | File | 是 | 图纸文件,非计算书时必须为 .dwg 文件 |
| pastFileSizeSum | Number | 是 | 历史已上传文件大小总和,用于统计上传进度,首个文件传 0 |
| projectId | String | 是 | 项目 ID |
| fileName | String | 是 | 文件名称(含扩展名),主文件名长度不超过 100 个字符 |
| fileType | String | 是 | 图纸类型,取值参见图纸类型 |
| major | String | 是 | 专业,取值参见专业 |
| itemName | String | 是 | 子项名称 |
| compareType | String | 是 | 比对类型,0 表示原图纸,1 表示比对图纸 |
请求示例
bash
curl -X POST "https://openapi.bangtu-ai.com/openApi/uploadDrawing" \
-H "apiKey: YOUR_API_KEY" \
-H "Platform: INSPECTOR" \
-F "file=@./总平面图.dwg" \
-F "pastFileSizeSum=0" \
-F "projectId=1900123456789012345" \
-F "fileName=总平面图.dwg" \
-F "fileType=DRAWING" \
-F "major=BUILDING" \
-F "itemName=1#楼" \
-F "compareType=0"返回结果
json
{
"code": 200,
"message": "success",
"data": {
"filePath": "openApi/1900123456789012345/总平面图.dwg",
"fileName": "总平面图.dwg",
"fileId": "1900456789012345678",
"time": 1784533680000,
"projectId": "1900123456789012345",
"fileType": "DRAWING",
"roundedSize": 2.35
},
"timestamp": 1784533680000
}返回字段
| 字段 | 类型 | 说明 |
|---|---|---|
| code | Number | 通用响应码,200 表示成功 |
| message | String | 响应信息 |
| data | Object | null | 上传成功后的文件信息 |
| timestamp | Number | 服务端响应时间戳,单位为毫秒 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
| filePath | String | 文件路径,用于文件下载与上传图纸完成并开启预审 |
| fileName | String | 文件名称 |
| fileId | String | 文件 ID |
| time | Number | 上传时间戳,单位为毫秒 |
| projectId | String | 项目 ID |
| fileType | String | 图纸类型 |
| roundedSize | Number | 文件大小,单位为 MB |
响应码
| code | 说明 |
|---|---|
| 200 | 请求成功 |
| 500 | 请求失败,具体原因见 message |
注意事项
- 文件为空时返回「文件为空」。
fileName、fileType、major、projectId为必填,缺失时返回「参数缺失」相关错误。- 非计算书文件必须以
.dwg结尾,否则返回「文件格式错误」。 - 仅结构(
STRUCTURE)专业支持上传计算书,其他专业返回「该专业不支持上传计算书」。 - 单个文件大小不能超过 100 MB,超出返回「文件过大」。
- 文件主名长度超过 100 个字符返回「文件名过长」。