接口帮助文档

文件管理接口

异步上传文件

接口地址:/async/upload/file

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
firstLevelFolder	一级文件夹名称	query	true	string
secondLevelFolder	二级文件夹名称	query	true	string
sourceService	来源系统名称	query	true	string
targetCategory	文件分类(部门文件还是项目文件)	query	true	string
userId	创建人唯一ID	query	true	string
zoneCode	板块编码	query	true	string
zoneName	板块名称	query	true	string
customName	用户自定义文件名称(带文件后缀)	query	false	string
deptCode	部门编码	query	false	string
deptName	部门名称	query	false	string
file	文件	query	false	file
projectCode	项目编码	query	false	string
projectName	项目名称	query	false	string
remark	备注	query	false	string
sourceKey	来源系统ID	query	false	string

响应参数:

参数名称	参数说明	类型	schema
code		string
data		string
msg		string
success		boolean
timeStamp		integer(int64)	integer(int64)
totalNumber		integer(int64)	integer(int64)

响应示例:

{
	"msg": "上传成功!",
	"code": "200",
	"data": "1559446094210097154",
	"totalNumber": 0,
	"success": true,
	"timeStamp": 1660635896843
}

根据文件唯一ID删除

接口地址:/delete/file

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	文件ID	body	true	string

响应参数:

参数名称	参数说明	类型	schema
code		string
data		object
msg		string
success		boolean
timeStamp		integer(int64)	integer(int64)
totalNumber		integer(int64)	integer(int64)

响应示例:

{
	"msg": "删除成功!",
	"code": "200",
	"data": null,
	"totalNumber": 0,
	"success": true,
	"timeStamp": 1660635896843
}

下载文件

接口地址:/download/file

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	文件ID	body	true	string
preview	是否预览	body	true	boolean

多文件打包下载

接口地址:/download/zip/file

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	文件ID	body	true	string
zipName	zip包名称(不带文件后缀)	body	false	string

上传文件

接口地址:/upload/file

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
firstLevelFolder	一级文件夹名称	query	true	string
secondLevelFolder	二级文件夹名称	query	true	string
sourceService	来源系统名称	query	true	string
targetCategory	文件分类(部门文件还是项目文件)	query	true	string
userId	创建人唯一ID	query	true	string
zoneCode	板块编码	query	true	string
zoneName	板块名称	query	true	string
customName	用户自定义文件名称(带文件后缀)	query	false	string
deptCode	部门编码	query	false	string
deptName	部门名称	query	false	string
file	文件	query	false	file
projectCode	项目编码	query	false	string
projectName	项目名称	query	false	string
remark	备注	query	false	string
sourceKey	来源系统ID	query	false	string

响应参数:

参数名称	参数说明	类型	schema
code		string
data		string
msg		string
success		boolean
timeStamp		integer(int64)	integer(int64)
totalNumber		integer(int64)	integer(int64)

响应示例:

{
	"msg": "上传成功!",
	"code": "200",
	"data": "1559446094210097154",
	"totalNumber": 0,
	"success": true,
	"timeStamp": 1660635896843
}