功能描述
用于列出回收站项目。
说明:
目录内容的列出顺序为:默认无排序,根据传入参数 orderBy 和 orderByType 来决定排列顺序。
请求
请求示例
GET /api/v1/recycled/{LibraryId}/{SpaceId}?page={Page}&page_size={PageSize}&order_by={OrderBy}&order_by_type={OrderByType}&access_token={AccessToken}&user_id={UserId}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | String | 是 | |
SpaceId | String | 否 | |
Marker | 用于顺序列出分页的标识,不能与 page 和 page_size 参数同时使用 | String | 否 |
Limit | 用于顺序列出分页时本地列出的项目数限制,不能与 page 和 page_size 参数同时使用 | String | 否 |
Page | 分页码,默认第一页,不能与 marker 和 limit 参数同时使用 | String | 否 |
PageSize | 分页大小,默认20,范围为[0,1000],不能与 marker 和 limit 参数同时使用 | String | 否 |
OrderBy | 排序字段,按名称排序为 name,按修改时间排序为 modificationTime,按文件大小排序为 size,按删除时间排序为 removalTime,按剩余时间排序为 remainingTime | String | 否 |
OrderByType | 排序方式,升序为 asc,降序为 desc | String | 否 |
AccessToken | String | 否 | |
UserId | String | 否 |
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"totalNum":34562,"nextMarker": 1013,"contents": [{"recycledItemId": 312,"originalPath": [ "初始化图片2.jpg" ],"spaceId": "spaceXXX","size": "3178496","previewByDoc": true,"previewByCI": true,"previewAsIcon": true,"fileType": "powerpoint","name": "初始化图片2.jpg","type": "file","creationTime": "2021-03-25T10:08:05.000Z","modificationTime": "2021-07-15T12:48:07.000Z","removalTime": "2021-07-16T07:15:36.000Z","remainingTime": 90,"authorityList":{"canRestore": true,"canDelete": true},"authorityButtonList":{"showViewButton": false,"showPreviewButton": false,"showDownloadButton": false,"showUploadButton": false,"showDeleteButton": true,"showAuthorizeButton": false,"showShareButton": false,"showModifyButton": false,"showRestoreButton": true}}]}
响应体字段说明:
响应参数 | 描述 | 类型 |
totalNum | 回收站所有文件和文件夹总数 | Int |
nextMarker | 用于顺序列出分页的标识 | String/Int |
contents | 目录或相簿内的具体内容 | Array |
contents 中的具体内容:
参数 | 描述 | 类型 |
recycledItemId | 回收站id | Number |
originalPath | 原始路径 | Array |
spaceId | 空间 ID | String |
size | 文件大小 | String |
previewByDoc | 是否可通过 WPS 预览 | Boolean |
previewByCI | 是否可通过万象预览 | Boolean |
previewAsIcon | 是否可用预览图当作 icon | Boolean |
fileType | 文件类型:Excel、PowerPoint 等 | String |
name | 目录或相簿名或文件名 | String |
spaceId | 空间Id | String |
type | 条目类型: dir: 目录或相簿file: 文件,仅用于文件类型媒体库image: 图片,仅用于媒体类型媒体库video: 视频,仅用于媒体类型媒体库 | String |
creationTime | 表示目录或相簿的创建时间或文件的上传时间,例如 2020-10-14T10:17:57.953Z | String |
modificationTime | 表示目录或相簿的修改时间,例如 2020-10-14T10:17:57.953Z | String |
removalTime | 表示目录或相簿的删除时间,例如 2020-10-14T10:17:57.953Z | String |
remainingTime | 剩余天数,不足一天的部分不计入 | Number |
authorityList | 允许操作的权限 | Array |
authorityButtonList | 允许操作的按钮权限 | Array |
authorityList 包含以下参数:
参数 | 描述 | 类型 |
canRestore | 可以恢复 | Boolean |
canDelete | 可以删除 | Boolean |
authorityButtonList 包含以下参数:
参数 | 描述 | 类型 |
showViewButton | 展示浏览按钮 | Boolean |
showPreviewButton | 展示预览按钮 | Boolean |
showDownloadButton | 展示下载按钮 | Boolean |
showUploadButton | 展示上传按钮 | Boolean |
showDeleteButton | 展示删除按钮 | Boolean |
showAuthorizeButton | 展示授权按钮 | Boolean |
showShareButton | 展示分享按钮 | Boolean |
showModifyButton | 展示修改按钮 | Boolean |
showRestoreButton | 展示恢复按钮 | Boolean |