还原回收站文件
还原回收站文件
请求说明
请求地址 | https://openapi.wps.cn/v7/deleted_files/{file_id}/restore |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理回收站(应用授权) kso.deleted_file.readwrite 查询和管理回收站(用户授权) kso.deleted_file.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:`` |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
file_id | string |
请求地址示例
[POST] https://openapi.wps.cn/v7/deleted_files/{file_id}/restore
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ created_by | object | 文件创建者信息; |
∟ ∟ avatar | string | 用户或应用的头像 |
∟ ∟ company_id | string | 身份所归属的公司 |
∟ ∟ id | string | 身份 id |
∟ ∟ name | string | 用户或应用的名称 |
∟ ∟ type | string[enum] | 身份类型 user :用户;sp :服务主体;unknown :未知 |
∟ ctime | integer | 文件创建时间 |
∟ drive | object | |
∟ ∟ allotee_id | string | 盘归属身份 id |
∟ ∟ allotee_type | string[enum] | 盘归属身份类型 user :用户;group :用户组;app :应用 |
∟ ∟ company_id | string | 企业 id |
∟ ∟ created_by | object | 创建者; |
∟ ∟ ∟ avatar | string | 用户或应用的头像 |
∟ ∟ ∟ company_id | string | 身份所归属的公司 |
∟ ∟ ∟ id | string | 身份 id |
∟ ∟ ∟ name | string | 用户或应用的名称 |
∟ ∟ ∟ type | string[enum] | user :用户;sp :服务主体;unknown :未知 |
∟ ∟ ctime | integer | 创建时间 |
∟ ∟ description | string | 盘描述 |
∟ ∟ ext_attrs | array[object] | 盘扩展属性 |
∟ ∟ ∟ name | string | 属性名 |
∟ ∟ ∟ value | string | 属性值 |
∟ ∟ id | string | 驱动盘 id |
∟ ∟ mtime | integer | 修改时间 |
∟ ∟ name | string | 驱动盘名称 |
∟ ∟ quota | object | 盘容量 |
∟ ∟ ∟ deleted | integer | 回收站中的文件占用的总空间,以字节为单位。只读 |
∟ ∟ ∟ remaining | integer | 剩余的总空间,以字节为单位。只读 |
∟ ∟ ∟ total | integer | 允许的总存储空间,以字节为单位。只读 |
∟ ∟ ∟ used | integer | 已使用的总空间,以字节为单位。只读 |
∟ ∟ source | string | 盘来源 |
∟ ∟ status | string[enum] | 盘状态 inuse :使用中;deleted :已删除 |
∟ drive_id | string | 驱动盘 id |
∟ ext_attrs | array[object] | 文件扩展属性 |
∟ ∟ name | string | 属性名 |
∟ ∟ value | string | 属性值 |
∟ id | string | 文件 id |
∟ link_id | string | 分享 id |
∟ link_url | string | 分享链接 url |
∟ modified_by | object | 文件修改者信息; |
∟ ∟ avatar | string | 用户或应用的头像 |
∟ ∟ company_id | string | 身份所归属的公司 |
∟ ∟ id | string | 身份 id |
∟ ∟ name | string | 用户或应用的名称 |
∟ ∟ type | string[enum] | 身份类型 user :用户;sp :服务主体;unknown :未知 |
∟ mtime | integer | 文件修改时间 |
∟ name | string | 文件名 |
∟ parent_id | string | 父目录 id |
∟ permission | object | 文件权限 |
∟ ∟ comment | boolean | 评论 |
∟ ∟ copy | boolean | 复制 |
∟ ∟ copy_content | boolean | 内容复制 |
∟ ∟ delete | boolean | 文件删除 |
∟ ∟ download | boolean | 下载 |
∟ ∟ history | boolean | 历史版本,仅公网支持 |
∟ ∟ move | boolean | 文件移动 |
∟ ∟ new_empty | boolean | 新建 |
∟ ∟ perm_ctl | boolean | 权限管理 |
boolean | 打印 | |
∟ ∟ rename | boolean | 文件重命名 |
∟ ∟ saveas | boolean | 另存为,仅公网支持 |
∟ ∟ secret | boolean | 安全文档,仅公网支持 |
∟ ∟ share | boolean | 分享 |
∟ ∟ update | boolean | 编辑 / 更新 |
∟ ∟ upload | boolean | 上传:手动上传新版本 |
∟ shared | boolean | 是否开启分享,当 link.status = 'open' 时,shared 为 true,其他结果为 false。若调用方想提前知道文档是否分享但又不想额外调用分享信息,可使用此字段 |
∟ size | integer | 文件大小 |
∟ type | string[enum] | 文件类型 folder :文件夹;file :文件;shortcut :快捷方式 |
∟ version | integer | 文件版本 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "string[enum]"
},
"ctime": 0,
"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",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"link_id": "string",
"link_url": "string",
"modified_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "string[enum]"
},
"mtime": 0,
"name": "string",
"parent_id": "string",
"permission": {
"comment": false,
"copy": false,
"copy_content": false,
"delete": false,
"download": false,
"history": false,
"move": false,
"new_empty": false,
"perm_ctl": false,
"print": false,
"rename": false,
"saveas": false,
"secret": false,
"share": false,
"update": false,
"upload": false
},
"shared": false,
"size": 0,
"type": "string[enum]",
"version": 0
},
"msg": "string"
}