1. 获取项目根目录结构

获取项目根目录接口,获取key为{key}的项目下的文件夹。

请求方式:GET

请求地址:/bosdocumentservice/{appKey}/projects/{key}/folders?noRelation={noRelation}

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_token

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key
key string 33a895949c2d4c27a0973b2a162b72a9 项目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": [
            {}    //返回数据内容
        ],
        "count": 10,
        "page": 1,
        "per_page": 20
    }
}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当{key}的project不存在时
200 ENTITY_READPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的读权限 NULL 如对指定key的项目无读权限

1.5. 注意事项:

1、需创建好项目。

2、当noRelation为false时,同时返回用户有权限获取的关联关系。

3、noRelation如若未传默认值为false,如若参数值非法按默认值为false处理。

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""