功能描述
用于列出回收站项目。
接口说明
目录内容的列出顺序为:默认无排序,根据传入参数 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:媒体库 ID,必选参数。
SpaceId:空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(
-
);如果媒体库为多租户模式,则必须指定该参数。Page:分页码,默认第一页,可选参数。
PageSize:分页大小,默认 20,可选参数。
OrderBy:排序字段,按名称排序为 name,按修改时间排序为 modificationTime,按文件大小排序为 size,按删除时间排序为 removalTime,按剩余时间排序为 remainingTime;
OrderByType:排序方式,升序为 asc,降序为 desc;
AccessToken:访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数。
UserId:用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅 生成访问令牌接口,可选参数。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"totalNum":34562,"nextMarker": 1013,"contents": [{"creationTime": "2021-03-25T10:08:05.000Z","modificationTime": "2021-07-15T12:48:07.000Z","name": "初始化图片2.jpg","originalPath": ["初始化图片2.jpg"],"recycledItemId": 312,"remainingTime": 90,"removalTime": "2021-07-16T07:15:36.000Z","size": "3178496","type": "file","previewByDoc": true,"previewByCI": true,"previewAsIcon": true,"fileType": "powerpoint","authorityList":{"canRestore": 1,"canDelete": 1,},}]}
响应体字段说明:
totalNum: 整数,回收站所有文件和文件夹总数。
contents:对象数组,目录或相簿内的具体内容:
name:字符串,目录或相簿名或文件名。
type:字符串,条目类型:
dir
:目录或相簿。file
:文件,仅用于文件类型媒体库。image
:图片,仅用于媒体类型媒体库。video
:视频,仅用于媒体类型媒体库。remainingTime:数字,剩余天数,不足一天的部分不计入。
originalPath:数组,原始路径。
recycledItemId:数字,回收站 ID。
removalTime:ISO 8601格式的日期与时间字符串,表示目录或相簿的删除时间,例如
2020-10-14T10:17:57.953Z
。modificationTime:ISO 8601格式的日期与时间字符串,表示目录或相簿的修改时间,例如
2020-10-14T10:17:57.953Z
。creationTime:ISO 8601格式的日期与时间字符串,表示目录或相簿的创建时间或文件的上传时间,例如
2020-10-14T10:17:57.953Z
。size:文件大小,为了避免数字精度问题,这里为字符串格式。
previewByDoc:是否可通过 wps 预览。
previewByCI:是否可通过万象预览。
previewAsIcon:是否可用预览图当做 icon。
fileType:文件类型:excel、powerpoint 等。
authorityList 允许操作的权限。
canRestore:可还原。
canDelete:可永久删除。