1. 还原回收站内文件夹、文档
还原回收站内的文件夹、文档。
请求方式:POST
请求地址:/bosdocumentservice/{appKey}/retired
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
[
{
"bosclass": "folders", //文件夹类名
"key": "123" //文件夹Key
},
{
"bosclass": "documents", //文件夹类名
"key": "456" //文件夹Key
}
]
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code:200
[
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://bosgw.bimwinner.com/bosdocumentservice/h5e4ff8257dc4e86a8042097f67d2718/folders/xxxx"
},
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://bosgw.bimwinner.com/bosdocumentservice/h5e4ff8257dc4e86a8042097f67d2718/documents/xxxx"
}
]
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | ENTITY_WRITEPERMISSION_REQUIRED | 缺少实体对象{bosclass/key}的写权限 | NULL | 对父文件夹或文档所属的文件夹无写权限 |
200 | RECYCLED_ENTITY_OBJECT_NOTFOUND | 回收站中Key为{key}的{entity}对象不存在 | NULL | {key}的{bosclass}不存在时 |
200 | JSON_FORMAT_WRONG | Json格式错误 | NULL | 传入Body格式错误时 |
200 | BODY_PARAMETER_INVALID | 接口body传参无效 | NULL | bosclass,key不传或为空时 |
1.5. 注意事项:
1、可同时还原回收站内的文件夹、文档。
2、如父文件夹或文档原所属文件夹不存在,则恢复父文件夹(回收站状态)或重建父文件夹(彻底删除状态),依此类推。
3、还原文件夹时还原文件夹的父子关系,包括更新该文件夹的longCode、longName、level属性。
4、还原文档时更新文档所属所有上层文件夹的size属性、同时还原与物理文件、原所属文件夹的关联关系。
5、还原文件夹时需对父文件夹有写权限;还原文档时需对所属文件夹有写权限。