文档中心

RemoteFileService

com.magus.cloud.document.client.api.RemoteFileService

upload

接口说明

文件上传

请求地址

POST /doc-center/upload

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileModel		Object			com.magus.cloud.document.client.model.request.FileModel
file	fileModel	String	0		文件
appCode	fileModel	String	0	framework:system	应用code
bizKey	fileModel	String	0		业务主键
tags	fileModel	String	0	名称	标签
filePath	fileModel	String	0	framework:system/202309/82ae8bf8-e667-4f51-8c93-4bc64d6e6a10-系统日志_20230913170956.xlsx	文件路径
remark	fileModel	String	0	文件备注	备注

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明

请求示例

{
  "file": {},
  "appCode": "",
  "bizKey": "",
  "tags": "",
  "filePath": "",
  "remark": ""
}

响应示例

uploadBatch

接口说明

文件批量上传

请求地址

POST /doc-center/upload/batch

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileModel		Object			com.magus.cloud.document.client.model.request.FileModel
multipartFiles	fileModel	Array	0		文件
appCode	fileModel	String	0	framework:system	应用code

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		Array
fileId	result	String	文件ID
fileName	result	String	文件名

请求示例

{
  "multipartFiles": [
    {}
  ],
  "appCode": ""
}

响应示例

[{
  "fileId": "",
  "fileName": ""
}]

download

接口说明

文件下载-返回流

请求地址

GET /doc-center/downloadStream/{fileId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileId		String	1		文件ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明

请求示例

响应示例

getDownloadUrl

接口说明

文件下载-返回下载链接

请求地址

GET /doc-center/downloadUrl/{fileId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileId		String	1		文件ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明

请求示例

响应示例

listDownloadUrl

接口说明

批量文件下载-返回下载链接

请求地址

POST /doc-center/downloadUrl/batch

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileIds		Array	1		文件ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		Array
id	result	String	id
fileName	result	String	文件名
fileSize	result	String	文件大小
fileType	result	String	文件类型
appCode	result	String	应用code
bizKey	result	String	业务主键
targetCode	result	String	存储目标主键
tags	result	String	标签
storePath	result	String	文件存储路径
remark	result	String	备注
fileUrl	result	String	文件路径
createBy	result	String	创建人
lastModifiedBy	result	String	更新人
createDate	result	Date	创建时间
lastModifiedDate	result	Date	更新时间

请求示例

响应示例

[{
  "id": "",
  "fileName": "",
  "fileSize": "",
  "fileType": "",
  "appCode": "",
  "bizKey": "",
  "targetCode": "",
  "tags": "",
  "storePath": "",
  "remark": "",
  "fileUrl": "",
  "createBy": "",
  "lastModifiedBy": "",
  "createDate": "2023-11-21 09:07:52",
  "lastModifiedDate": "2023-11-21 09:07:52"
}]

getPreviewUrl

接口说明

文件下载-返回预览链接

请求地址

GET /doc-center/previewUrl/{fileId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileId		String	1		文件ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		String

请求示例

响应示例

delete

接口说明

文件删除

请求地址

DELETE /doc-center/files/{fileId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileId		String	1		文件ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		String

请求示例

响应示例

deleteByFileIds

接口说明

文件批量删除

请求地址

DELETE /doc-center/files

请求参数

参数名	父级	类型	是否必须	示例值	描述
fileIds		Array	1		文件ID

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明

请求示例

响应示例

deleteBatch

接口说明

文件批量删除

请求地址

DELETE /doc-center/files/batch

请求参数

参数名	父级	类型	是否必须	示例值	描述
appCode		String	1		应用code
path		String	1		路径

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
success		boolean
message		String
data		Object

请求示例

响应示例

{
  "success": false,
  "message": "",
  "data": {}
}