1. 获取回收站内文件夹、文档列表
获取回收站内的文件夹、文档列表。
请求方式:GET
请求地址:/bosdocumentservice/{appKey}/retired
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
noRelation | boolean | true/false | 否 | true表示不返回关联关系,false表示返回所有关联关系 |
whitelist | string | xxx,yyy,zzz | 否 | 指定返回属性字段,多个属性字段英文逗号隔开 |
limit | number | 5 | 否 | 指定返回记录的数量 |
offset | number | 1 | 否 | 指定返回记录的开始位置 |
page | number | 2 | 否 | 指定第几页,依赖参数:per_page |
per_page | number | 10 | 否 | 每页的记录数,依赖参数:page |
sortby | string | order | 否 | 指定返回结果按照哪个属性排序,依赖参数:order |
order | string | asc/desc | 否 | 排序顺序:asc为升序,desc为降序,依赖参数:sortby |
Body:
application/json:
NULL
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code:200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": {
"data": [
{
"gdataType": "folders",
"xxx": "xxx" #文件夹其他属性按"3.1.3 GET方法返回对象内容说明"parameter定义的规则返回。
},
{
"gdataType": "documents",
"xxx": "xxx" #文件夹其他属性按"3.1.3 GET方法返回对象内容说明"parameter定义的规则返回。
}
],
"count": 10,
"page": 1,
"per_page": 20
}
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.5. 注意事项:
排序时文件夹排在前面,文件夹、文档分别按照搜索参数中执行的方式进行排序。