功能描述
用于查看最近使用文件列表。
说明:
使用此功能需开通白名单,如有需求请 联系我们。
要求权限:admin、space_admin。有关权限详情请参见 生成访问令牌接口。
仅文件预览及文件编辑操作会被记录到最近使用文件列表中。
返回的文件列表按照操作时间进行倒序排列。
请求
请求示例
POST /api/v1/recent/{LibraryId}/{SpaceId}/recently-used-file?access_token={AccessToken}
请求体
{"marker":"NKJWNDkndkwjqndkqnwdkjnqwd=","limit":10,"filterActionBy": "preview","type": [".doc", ".csv"],"withPath": true}
请求体字段说明:
请求参数 | 描述 | 类型 | 是否必选 |
marker | 用于顺序列出分页的标识,不传默认第一页 | String | 否 |
limit | 用于顺序列出分页时本地列出的项目数限制,不传则默认20 | Int | 否 |
filterActionBy | filterActionBy: 筛选操作方式,不传返回全部,preview 只返回预览操作,modify 返回编辑操作 | String | 否 |
type | 筛选文件类型,当前支持的类型包括: all: 搜索所有文件,当不传 type 或传空时默认为 all; document: 搜索所有文档,文档类型为:['pdf', 'powerpoint', 'excel', 'word' 'text'] pdf: 仅搜索 PDF 文档,对应的文件扩展名为 .pdf; powerpoint: 仅搜索演示文稿,如 .ppt、.pptx、.pot、.potx 等; excel: 仅搜索表格文件,如 .xls、.xlsx、.ett、.xltx、.csv 等; word: 仅搜索文档,如 .doc、.docx、.dot、.wps、.wpt 等; text: 仅搜索纯文本,如 .txt、.asp、.htm 等; doc、xls 或 ppt: 仅搜索 Word、Excel 或 Powerpoint 类型文档,对应的文件扩展名为 .doc(x)、.xls(x) 或 .ppt(x); 字符串数组: 可以是文档后缀数组,如 ['.ppt', '.doc', '.excel']等;也可以是上述筛选类型数组,如 ['pdf', 'powerpoint', 'word'] 等 | String Array /String | 否 |
withPath | 是否返回文件路径,默认为 false | Boolean | 否 |
响应
响应码
查看最近使用文件列表成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"nextMarker": "xxx","contents": [{"name": "文档.doc","spaceId": "spacexxx","inode": "xxxxx","size": "1111","actionType": "preview","operationTime": "2022-04-25T07:53:18.000Z","creationTime": "2022-04-23T07:53:18.000Z","crc64": "xxxxxx","path": ["folder1", "文档.doc"]}]}
响应体字段说明:
响应参数 | 描述 | 类型 |
nextMarker | 用于顺序列出分页的标识,仅当不为最后一页时会返回该字段 | String |
contents | 最近使用文件列表的具体内容 | Array |
contents中包含以下参数:
响应参数 | 描述 | 类型 |
name | 文件名 | String |
spaceId | 空间ID | String |
inode | 文件ID | String |
size | 文件大小,为了避免数字精度问题,这里为字符串格式 | String |
actionType | 加入最近使用列表时的操作类型,可能的值为 preview 或 modify | String |
operationTime | ISO 8601格式的日期与时间字符串,表示加入最近使用文件列表的时间,例如 2020-10-14T10:17:57.953Z | String |
creationTime | ISO 8601格式的日期与时间字符串,表示文件的上传时间,例如 2020-10-14T10:17:57.953Z | String |
crc64 | 文件的 CRC64-ECMA182 校验值,为了避免数字精度问题,这里为字符串格式 | String |
path | 表示文件的路径,仅当 withPath 为 true 时返回该字段 | String Array |