1. 获取文件夹下的文件夹和文档
获取文件夹下的文件夹和文档。
请求方式：POST
请求地址：/bosdocumentservice/{appKey}/folders/folders&documents
1.1. 请求参数：
Headers：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
Body：
application/json：
{
"key": "F1 #文件夹key。如果不传，结果为返回所有根文件夹信息；",
"entity": "both # 查询的类别，只查文件夹(folders),只查文档(documents),都查(both),\t默认为both",
"page": 1,
"per_page": 20,
"sortby": "name # 指定返回结果按照哪个属性排序；",
"order": " asc #排序，asc升序，desc降序",
"condition": [
{
"field": "name # 查询字段",
"operator": "like # 匹配规则 精确查询( = )，模糊查询(like)，大于查询( > )等等",
"value": "zhao # 值",
"number": "false # 比较时将内容转化为数字后再比较",
"logic": " # 条件连接,值只可为Or,\tAnd"
}
],
"nestAnd": [
{
"field": "name",
"operator": "like",
"value": "doc",
"number": "false"
},
{
"nestOr": [
{
"field": "name",
"operator": "like",
"value": "a",
"number": "false"
}
]
}
]
}
1.2. 参数说明：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回：
Http Status Code：200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": {
"data": [
{
"gdataType": "folders",
"bosclass": "folders",
"code": "FLD-1913-001",
"description": "",
……
},
{
"gdataType": "documents",
"bosclass": "documents",
"code": "document1913-5",
"description": "",
"gLongCode": "", #所属文件夹code路径
"gLongName": "" #所属文件夹name路径
……
}
],
"count": 10,
"page": 1,
"per_page": 20
}
}
1.4. 状态码：
| 状态码 | code | message | data | 原因 |
|---|---|---|---|---|
| 200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当{key}的folder不存在时 |
| 200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{entity/key}的读权限 | NULL | 当前用户如无权读取文件夹时 |
| 200 | JSON_FORMAT_WRONG | Json格式错误 | NULL | 当传入Body格式错误时 |
| 200 | ENTITY_QUERY_LOGIC_SETTING_INVALID | logic参数值{logic}无效 | NULL | 如codition参数中logic值为Or |
| 200 | ENTITY_QUERY_NUMBER_SETTING_CONFLICT | 不可同时设置number为true | NULL | 如codition参数中number值为true |
| 200 | ENTITY_QUERY_NUMBER_CONVERT_WRONG | value参数值{value }非数字 | NULL | 如codition参数中number值为true |
| 200 | ENTITY_QUERY_NUMBER_SETTING_INVALID | number参数值{number}无效 | NULL | 如codition参数中number值为true |
| 200 | ENTITY_QUERY_PAGE_SETTING_INVALID | page参数值{page}非数字 | NULL | 参数page为数字以外的值时 |
| 200 | ENTITY_QUERY_PERPAGE_SETTING_INVALID | per_page参数值{per_page}非数字 | NULL | 参数per_page值为数字以外的值时 |
| 200 | ENTITY_QUERY_ORDER_SETTING_INVALID | order参数值{order}无效 | NULL | 参数order值为asc或desc以外的值时 |
1.5. 注意事项：
前提需创建文件夹，且在文件夹下创建文档。