功能描述
用于删除文件。
接口说明
要求权限:
非 acl 鉴权:admin、space_admin 或 delete_file(未开启回收站或 Permanent 为 0)/delete_file_permanent(开启回收站且 Permanent 为 1)
acl 鉴权:canDelete(当前文件夹可删除)
如果媒体库启用回收站功能,则该接口不会永久删除文件,而是将文件移入回收站,可通过相关接口永久删除或恢复回收站内的文件,或直接清空回收站。
请求
请求示例
DELETE /api/v1/file/
{LibraryId}
/{SpaceId}
/{FilePath}
?permanent={Permanent}
&access_token={AccessToken}
&user_id={UserId}
请求参数:
LibraryId:媒体库 ID,必选参数。
SpaceId:空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(
-
);如果媒体库为多租户模式,则必须指定该参数。FilePath:完整文件路径,例如
foo/bar/file.docx
。Permanent:当媒体库开启回收站时,则该参数指定将文件移入回收站还是永久删除文件,1:永久删除,0:移入回收站,默认为0。
AccessToken:访问令牌,必选参数。
UserId:用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅 生成访问令牌接口,可选参数。
请求体
该请求无请求体。
响应
响应码
删除成功,返回 HTTP 204 No Content(未开启回收站)或 HTTP 200 OK(开启回收站)。
响应体
空,无响应体(未开启回收站)或 application/json(开启回收站)。
响应体示例:(开启回收站)
{"recycledItemId": 123}
响应体字段说明:
recycledItemId:回收站项目 ID,用于从回收站永久删除或恢复指定项目。