1. 文件服务API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 1.1 | 上传文件服务-流 | /v1/iot/file/multipart/upload | 1.0 |
| 1.2 | 上传文件服务-base64 | /v1/iot/file/base64/upload | 1.0 |
| 1.3 | html转pdf | /v1/iot/file/htmltopdf | 1.0 |
| 1.4 | url转pdf | /v1/iot/file/urltopdf | 1.0 |
| 1.5 | 文件下载-流 | /v1/iot/file/multipart/get | 1.0 |
| 1.6 | 文件列表 | /v1/iot/file/log/list | 1.0 |
| 1.7 | 文件删除 | /v1/iot/file/log/remove/{id} | 1.0 |
API调用
1.1: 上传文件服务-流
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/multipart/upload
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| fileName | form | string | y | 文件名 |
| fileExt | form | string | n | 文件扩展名 |
| businessId | form | string | y | 业务id |
| businessType | form | string | y | 业务类型 |
| file | form | file | y | 上传的文件 |
| contentType | form | string | n | 文件类型 |
请求Body描述(Form表单数据)
fileName:19楼
fileExt:png
businessId:22222222
businessType:community
file: file
contentType: application/octet-stream
详见：
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| filePath | data | strin | y | 文件路径 |
返回结果示例
{
"code": 200,
"data": {
"filePath": "https://iot-xlink-xfile.oss-cn-hangzhou.aliyuncs.com/community/2020-12-23/134354560.png",
"id":"主键",
"fileName":"文件名",
"businessId":"文件所关联的业务id",
"businessType":"文件所关联的业务类型",
"fileExt":"文件扩展名",
"contentType":"文件类型",
"remotePath":"文件远程地址",
"fileUri":"文件路径",
},
"message": "success"
}
1.2: 上传文件服务-base64
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/base64/upload
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| fileName | body | string | y | 文件名 |
| fileExt | body | string | n | 文件扩展名 |
| businessId | body | string | y | 业务id |
| businessType | body | string | y | 业务类型 |
| fileBase64Content | body | file | y | 上传的文件base64 |
请求Body描述(非Form表单数据)
"fileName": "19楼""
"fileExt": "png"
"businessId": "22222222"
"businessType": "community",
"fileBase64Content": ""
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| filePath | data | strin | y | 文件路径 |
返回结果示例
{
"code": 200,
"data": {
"filePath": "https://iot-xlink-xfile.oss-cn-hangzhou.aliyuncs.com/community/2020-12-23/134354560.png",
"id":"主键",
"fileName":"文件名",
"businessId":"文件所关联的业务id",
"businessType":"文件所关联的业务类型",
"fileExt":"文件扩展名",
"contentType":"文件类型",
"remotePath":"文件远程地址",
"fileUri":"文件路径",
},
"message": "success"
}
1.3: html转pdf
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/htmltopdf
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| htmlContent | body | string | y | html内容 |
| fileName | body | string | y | 文件名 |
请求Body描述(非Form表单数据)
{
"htmlContent": "<!DOCTYPE html><html lang=\"en\"><head><meta charset=\"UTF-8\"><title>Title</title></head><body>dsfdsfdsfsd</body></html>",
"fileName": "23344532.pdf"
}
返回信息
返回参数类型
pdf file
1.4: url转pdf
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/urltopdf
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| htmlUrl | body | string | y | html内容 |
| fileName | body | string | y | 文件名 |
请求Body描述(非Form表单数据)
{
"htmlUrl": "http://xxxxxxxx",
"fileName": "23344532.pdf"
}
返回信息
返回参数类型
pdf file
1.5: 文件下载
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/multipart/get
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| filePath | body | string | y | 文件路径 |
| fileName | body | string | y | 文件名 |
请求Body描述(非Form表单数据)
{
"filePath": "",
"fileName": ""
}
返回信息
file
业务类型:
| 类型code | 描述 |
|---|---|
| customer | 客户 |
| community | 项目 |
1.6: 文件列表
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/log/list
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| businessId | body | string | y | 业务ID |
请求Body描述(非Form表单数据)
{
"businessId": "123"
}
返回信息
{
"code": 200,
"data": [
{
"id": 5,
"fileName": "19楼.png",
"businessId": "123455",
"businessType": "community",
"fileExt": "png",
"contentType": null,
"remotePath": "https://iot-xlink-xfile.oss-cn-hangzhou.aliyuncs.com/community/2020-12-18/12345519楼.png.png",
"fileUri": "community/2020-12-18/12345519楼.png.png",
"deleteFlag": null,
"createBy": null,
"createTime": "2020-12-18T05:06:30.000+0000",
"updateBy": null,
"updateTime": null
}
],
"message": "success"
}
返回参数类型
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | data | int | y | ID |
| fileName | data | string | y | 文件名 |
| businessId | data | string | y | 业务ID |
| businessType | data | string | y | 业务类型 |
| fileExt | data | string | y | 文件扩展名 |
| contentType | data | string | y | 内容编码 |
| remotPath | data | string | y | 远程地址 |
| fileUri | data | string | y | 文件路径 |
1.7: 文件删除
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/file/log/remove/{id}
方法：DELETE
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | url | string | y | 附件id |
请求Body描述(非Form表单数据)
返回信息
{
"code": 200,
"data":
{
,
"message": "success"
}