1. 列出文件夹包含的文档
列出文件夹包含的文档,获取key为{key}的文件夹下的文档。
请求方式:GET
请求地址:/bosdocumentservice/{appKey}/folders/{key}/documents?allVersion=true&noRelation={noRelation}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
key | string | 5c25f513425b45ea3dr1aa435ca43ft6 | 是 | 文件夹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": [
{
//数据体按"3.1.3 GET方法返回对象内容说明"定义的规则返回数据内容。
"gLongCode": "", //所属文件夹key路径
"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 | 缺少实体对象{bosclass/key}的读权限 | NULL | 如{key}对应的文件夹无读权限 |
1.5. 注意事项:
1、需对文件夹{key}有读权限。
2、allVersion选填,true代表返回所有历史版本;false代表仅返回最高版本,如若未传默认值为false,如若参数值非法按默认值为false处理。
3、当noRelation为false时,同时返回用户有权限获取的关联关系。
4、noRelation如若未传默认值为false,如若参数值非法按默认值为false处理。
5、同时返回gLongCode、gLongName,gLongCode代表文档所属文件夹key路径,依次由根文件夹到文档所属直接文件夹的key组成,中间用※分隔;gLongName代表文档所属文件夹name路径,依次由根文件夹到文档所属直接文件夹的name组成,中间用※分隔