内容

错误码

Http Status Code errorCode desc
400 500 上传文件编码错误
501 上传文件过大
502 目标文件夹不存在
503 目标文件夹已存在
504 目标文件夹错误
505 目标文件夹下已存在相同文件
506 文件保存失败
507 操作文件不存在

1. 上传文件

描述

上传一个新的文件到ftp服务器中,并且通过activeMq通知FileConver Server进行文件转换。

输入说明

输入参数 参数含义 类型 必填 备注
access_token 访问令牌 string Y
file 文件域 MultipartFile Y
folderId 所属文件夹id String N 默认:-1(根目录)

输出说明

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 执行错误
files 上传的文件列表信息 list
id 文件id Long
name 文件名称 String
size 文件大小 Long

调用示例:

POST  /docs/file?access_token=cb906b1359ab4768a45c18d608a3c2e1

输入:
Content-Type: multipart/form-data
 ------WebKitFormBoundaryawdUELRLwoGaNYjV
                 Content-Disposition: form-data; name="folderId"
                 -1
 ------WebKitFormBoundaryawdUELRLwoGaNYjV
                Content-Disposition: form-data; name="file"; filename=""test.docx"
                Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
 ------WebKitFormBoundaryawdUELRLwoGaNYjV--

输出:
HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"files": [
{
"id": 224,
"name": "王国庆(1).docx",
"size": 0
}
]
}

2. 编辑文件

描述

更新文件的基本信息,包括文件的描述和自定义版本信息。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
fileId 文件id Long Y 不支持批量
description 文件描述 String N
customVersion 自定义版本号 String N

输出参数

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例:

PUT /docs/file/{fileId} ----------------------------{fileId}文件id
PUT /docs/file/3?access_token=cb906b1359ab4768a45c18d608a3c2e1&description=descriptionValue&customVersion=customVersionValue

输出:
HTTP/1.1 200 OK

3. 文件详情

描述

获取指定文件的详细信息,包括:名称、描述、大小和创建时间等。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
fileId 文件id Long Y 不支持批量

输出参数

输出参数 参数说明 类型 备注
id 文件id Long
fileName 名称 String
description 描述 String
fileSize 大小 Long 字节
createTime 创建时间 String 格式:yyyy-MM-dd HH:mm:ss
updateTime 更新时间 String 格式:yyyy-MM-dd HH:mm:ss
createBy 创建者 String
customVersion 自定义版本 String
status 状态 Integer 文件状态 0:禁用 1:启用
errorCode 错误码 Integer 具体值参见错误码表

调用示例:

GET /docs/file/{fileId} ------------{fileId}文件id
GET /docs/file/10?access_token=d4dc52caf75043f898a7ca3c1e9ffe3b

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"fileName": "1-关于运营平台.docx",
"createBy": "admin",
"fileSize": 271934,
"createTime": "2015-11-18 16:02:12",
"description": null,
"updateTime": "2015-11-18 16:02:12",
"id": 10,
"customVersion": "1.0",
"status": 0
}

4. 启用禁用文件

描述

对文件的进行启用/禁用,文件启用后被分发的文件才能在MCM Client中查看到。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
fileIds 文件id String Y 多个文件用“,”间隔
status 文件状态 String Y 1:启用 0:禁用

输出参数

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例:

PUT /docs/file/{fileIds}/to/{status} -------- {fileIds}文件id {status}文件状态
PUT/docs/file/1,2/to/1?access_token=cb906b1359ab4768a45c18d608a3c2e1

输出:
HTTP/1.1 200 OK

5. 分发文件

描述

根据用户所选择的的分发条件(文档操作权限、是否推送通知和用户/用户组信息),创建分发。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
fileIds 文件ids String Y 支持批量,多文件间用”,”间隔
relationships  设备所属关系  String N  1:公司设备 2:员工设备 3:其它,json数组
distributeType 是否推送通知 Integer N 0:不通知,1:通知,默认:0
authOperType 文件操作权限 Integer N 0:预览,1:预览下载,默认:0
groupIds 用户组ids String N 和userIds必填其一,json数组
userIds 用户ids String N 和groupIds必填其一,json数组
labelIds 标签ids String N 和groupIds,userIds不可同时输入,json数组

输出参数

输出参数 参数说明 类型 备注
fileId 文件id Long
distributeId 文件分发id Long
errorCode 错误码 Integer 具体值参见错误码表

调用示例

POST /docs/file/{fileIds}/distribution -------------{fileIds}文件id
POST /docs/file/3,7,8/distribution?access_token=ac87520e3c8e4ff7b859f72f6b8b66ad

输入:

Content-Type: application/json;charset=UTF-8
{
"relationships":[1,2,3],
"authOperType": 1,
"distributeType": 0,
"userIds": [34]
}

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"distributions": [
{
"distributeId": 72,
"fileId": 195
},
{
"distributeId": 73,
"fileId": 196
}
]
}

6. 查找文件

描述

根据指定条件(所属文件夹、格式、状态、时间、文件名或管理员账户),查询出所有的文件信息。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
folderIds 文件夹ids String Y 支持批量,多文件夹用”,”间隔
status 文件夹状态 Integer N 文件状态:0:禁用 1:启用
dateConditionType 日期过滤类型 String N 1:近三天 2:近一周 3:近两周 4:近一个月
paramFileType 文件类型 String N 10:word 11:excel 12:powerpoint 20:pdf
30:txt 31:csv 40:png 41:jpg 42:gif 43:bmp
50:html 60:tif
fileName 文件名称 String N
orderByFieldName 排序字段 String N
orderDirection 排序方式 String N DESC 或者 ASC

输出参数

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 具体值参见错误码表
total 记录数 Integer
rows 记录

输出参数 参数说明 类型 备注
id 文件id Long
fileName 文件名称 String
fileSize 文件大小 Long
customVersion 自定义版本 String
fileType 文件类型 Integer 10:word 11:excel 12:powerpoint 20:pdf
30:txt 31:csv 40:png 41:jpg 42:gif 43:bmp
50:html 60:tif
updateTime 更新时间 String 格式:yyyy-MM-dd HH:mm:ss
description 描述 String
status 文件启用/禁用状态 String 0:禁用 1:启用
isFile 是否为文件 String 1:文件
viewCount 可预览数 Integer
downloadCount 可下载数 Integer
distributeCount 分发数 Integer
canEditFlag 是否有编辑权限 String 0:不可以 1:可以
createBy 创建者 String
folderId 所属文件夹id Long
List

调用示例:

GET /docs/folder/{folderIds}/files ---------------------{folderIds}文件夹id

GET /docs/folder/-1/files?access_token=a41a92963821497eaa73135363126640&status=0&dateConditionType=4&fileName=admin&orderByFieldName=id&orderDirection=asc

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"total": 1,
"rows": [ {
"id": 6,
"fileName": "RESTful请求地址.xlsx",
"fileSize": 65777,
"customVersion": "1.0",
"fileType": 11,
"updateTime": "2015-12-02 15:27:51",
"description": null,
"status": "0",
"isFile": "1",
"viewCount": 0,
"downloadCount": 0,
"distributeCount": 0,
"canEditFlag": "1",
"createBy": "admin",
"folderId": -1
}]
}

7. 删除文件

描述

删除指定的文件,支持批量操作。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
fileIds 文件ids String Y 支持批量,多文件用”,”间隔

输出参数

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例:

DELETE /docs/file/{fileIds} -------------------{fileIds}文件id

DELETE /docs/file/6,7,8?access_token=d4dc52caf75043f898a7ca3c1e9ffe3b

输出:

HTTP/1.1 200 OK

8. 创建文件夹

描述

在指定的文件夹下创建新的文件夹。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
folderName 文件夹名称 String Y
parentFolderId 父文件夹id Long N

输出参数

输出参数 参数说明 类型 备注
id 文件夹id Long
name 文件夹名称 String
creator 创建者 String
createTime 创建时间 String 格式:yyyy-MM-dd HH:mm:ss
errorCode 错误码 Integer 具体值参见错误码表

调用示例:

POST /docs/folder?access_token=cb906b1359ab4768a45c18d608a3c2e1

输入:

Content-Type: application/json;charset=UTF-8
{
"folderName": "test",
"parentFolderId": -1
}

输出:

HTTP/1.1 200 OK 
Content-Type:application/json;charset=UTF-8
{
"creator": "admin",
"createTime": "2015-12-11 18:45:47"
,
"name": "aaaa",
"id": 3
}

9. 重命名文件夹

描述

修改文件夹的名称。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
id 文件夹id Long Y
newName 文件夹新名称 String Y

输出参数

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

PUT /docs/folder/{id} --------------{id}文件id

PUT /docs/folder/20?access_token=cb906b1359ab4768a45c18d608a3c2e1&newName=after

输出:

HTTP/1.1 200 OK

10. 移动文件夹

描述

移动选中的文件夹到指定的目录,支持批量操作。

输入参数

输入参数 参数说明 参数类型 必填 备注
access_token 访问令牌 String Y
folderIds 文件夹ids String Y 支持批量,多个值之间用”,”间隔
targetFolderId 目标文件夹id Long Y
originFolderId 当前文件夹id Long Y
overWrite 是否覆盖同名文件/文件夹 boolean N 默认值false,不覆盖

输出参数

输出参数 参数说明 参数类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例:

PUT /docs/folder/{folderIds}/from/{originFolderId}/to/{targetFolderId} -------------{folderId}文件夹id,{ownerId}当前文件夹id,{parentFolderId}目标文件夹id

PUT /docs/folder/24/from/-1/to/21?access_token=ac87520e3c8e4ff7b859f72f6b8b66ad&overWrite=true

输出:
HTTP/1.1 200 OK

11. 删除文件夹

描述

删除指定文件夹及其下的文件,支持批量操作。

输入参数

输入参数 参数说明 类型 必填 备注
access_token 访问令牌 String Y
folderIds 一个或多个文件夹id String Y 多个值之间用”,”间隔

输出参数

输出参数 参数说明 类型 备注
errorCode 错误码 Integer 具体值参见错误码表

调用示例

DELETE /docs/folder/{folderIds} ------------------{folderIds}文件夹id

DELETE /docs/folder/18,14,16,17?access_token=1fc8a5002005449ca15930fc94895311

输出:

HTTP/1.1 200 OK