Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取回收站文件列表

获取回收站文件列表

请求说明

请求地址https://openapi.wps.cn/v7/deleted_files
请求方法GET
签名方式KSO-1
权限要求查询回收站(应用授权) kso.deleted_file.read
查询回收站(用户授权) kso.deleted_file.read

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
drive_idstring
page_sizeinteger分页大小
page_tokenstring分页 token
with_driveboolean是否获取 drive 信息
with_ext_attrsboolean是否获取扩展属性

请求地址示例

[GET] https://openapi.wps.cn/v7/deleted_files?drive_id={string}&page_size={integer}&page_token={string}&with_drive={boolean}&with_ext_attrs={boolean}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]
∟ ∟ created_byobject回收站文件的创建者信息;
∟ ∟ ∟ avatarstring用户或应用的头像
∟ ∟ ∟ company_idstring身份所归属的公司
∟ ∟ ∟ idstring身份 id
∟ ∟ ∟ namestring用户或应用的名称
∟ ∟ ∟ typestring[enum]身份类型
user:用户;sp:服务主体;unknown:未知
∟ ∟ ctimeinteger
∟ ∟ deleted_byobject回收站文件的删除者信息;
∟ ∟ ∟ avatarstring用户或应用的头像
∟ ∟ ∟ company_idstring身份所归属的公司
∟ ∟ ∟ idstring身份 id
∟ ∟ ∟ namestring用户或应用的名称
∟ ∟ ∟ typestring[enum]身份类型
user:用户;sp:服务主体;unknown:未知
∟ ∟ driveobjectdrive 信息
∟ ∟ ∟ allotee_idstring盘归属身份 id
∟ ∟ ∟ allotee_typestring[enum]盘归属身份类型
user:用户;group:用户组;app:应用
∟ ∟ ∟ company_idstring企业 id
∟ ∟ ∟ created_byobject创建者;
∟ ∟ ∟ ∟ avatarstring用户或应用的头像
∟ ∟ ∟ ∟ company_idstring身份所归属的公司
∟ ∟ ∟ ∟ idstring身份 id
∟ ∟ ∟ ∟ namestring用户或应用的名称
∟ ∟ ∟ ∟ typestring[enum]身份类型
user:用户;sp:服务主体;unknown:未知
∟ ∟ ∟ ctimeinteger创建时间
∟ ∟ ∟ descriptionstring盘描述
∟ ∟ ∟ ext_attrsarray[object]盘扩展属性
∟ ∟ ∟ ∟ namestring属性名
∟ ∟ ∟ ∟ valuestring属性值
∟ ∟ ∟ idstring驱动盘 id
∟ ∟ ∟ mtimeinteger修改时间
∟ ∟ ∟ namestring驱动盘名称
∟ ∟ ∟ quotaobject盘容量
∟ ∟ ∟ ∟ deletedinteger回收站中的文件占用的总空间,以字节为单位。只读
∟ ∟ ∟ ∟ remaininginteger剩余的总空间,以字节为单位。只读
∟ ∟ ∟ ∟ totalinteger允许的总存储空间,以字节为单位。只读
∟ ∟ ∟ ∟ usedinteger已使用的总空间,以字节为单位。只读
∟ ∟ ∟ sourcestring盘来源
∟ ∟ ∟ statusstring[enum]盘状态
inuse:使用中;deleted:已删除
∟ ∟ drive_idstring
∟ ∟ dtimeinteger
∟ ∟ ext_attrsarray[object]文件扩展属性
∟ ∟ ∟ namestring属性名
∟ ∟ ∟ valuestring属性值
∟ ∟ hashobject
∟ ∟ ∟ sumstring哈希结果
∟ ∟ ∟ typestring[enum]哈希类型
sha256md5sha1s2s
∟ ∟ idstring
∟ ∟ modified_byobject回收站文件的修改者信息;
∟ ∟ ∟ avatarstring用户或应用的头像
∟ ∟ ∟ company_idstring身份所归属的公司
∟ ∟ ∟ idstring身份 id
∟ ∟ ∟ namestring用户或应用的名称
∟ ∟ ∟ typestring[enum]身份类型
user:用户;sp:服务主体;unknown:未知
∟ ∟ mtimeinteger
∟ ∟ namestring
∟ ∟ parent_idstring
∟ ∟ sizeinteger
∟ ∟ typestring* folder - 文件夹
* file - 文件
* shortcut - 快捷方式
∟ ∟ versioninteger
∟ next_page_tokenstring下一页 token
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string[enum]"
        },
        "ctime": 0,
        "deleted_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string[enum]"
        },
        "drive": {
          "allotee_id": "string",
          "allotee_type": "string[enum]",
          "company_id": "string",
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "string[enum]"
          },
          "ctime": 0,
          "description": "string",
          "ext_attrs": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "id": "string",
          "mtime": 0,
          "name": "string",
          "quota": {
            "deleted": 0,
            "remaining": 0,
            "total": 0,
            "used": 0
          },
          "source": "string",
          "status": "string[enum]"
        },
        "drive_id": "string",
        "dtime": 0,
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "hash": {
          "sum": "string",
          "type": "string[enum]"
        },
        "id": "string",
        "modified_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string[enum]"
        },
        "mtime": 0,
        "name": "string",
        "parent_id": "string",
        "size": 0,
        "type": "string",
        "version": 0
      }
    ],
    "next_page_token": "string"
  },
  "msg": "string"
}
回到旧版