1. 查询文件夹的树形结构数据

查询文件夹的树形结构数据。

请求方式:GET

请求地址:/bosdocumentservice/{appKey}/folders/query/tree/{key}?type={type}&depth={depth}

1.1. 请求参数:

Headers:

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

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key
key string 33a895949c2d4c27a0973b2a162b72a9 文件夹Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
depth string 5 搜索深度,用整数
type string parent/phild/both 搜索方向,Parent只向上搜索,为child只向下搜索,为both同时向上下搜索

Body:

application/json:

NULL

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.3. 正确返回:

Http Status Code:200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": {
        "xxx": "xxx",    //指定{key}对象具体属性信息
        "children": [    //如向下查找节点时子节点使用children标注
            {
                "xxx": "xxx",    //第二层节点对象具体属性信息
                "children": [
                    {
                        "xxx": "xxx"    //第三层节点的对象具体属性信息
                    }
                ]
            }
        ],
        "parents": [    //如向上查找节点时上层节点使用parents标注
            {
                "xxx": "xxx",    //直接上层节点对象具体属性信息
                "parents": [
                    {
                        "xxx": "xxx"    //上上层节点的对象具体属性信息 
                    }
                ]
            }
        ]
    }
}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{entity}实体对象不存在 NULL 当{key}对应的文件夹不存在时
200 ENTITY_READPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的读权限 NULL 如对{key}对应的文件夹无读权限
200 SEARCHPARAS_VALUE_INVALID 接口路径搜索参数{serchParas}值无效 NULL 当depth值非整数时
200 SEARCHPARAS_VALUE_INVALID 接口路径搜索参数{serchParas}值无效 NULL type不等于Parent、Child、Both中的任何一个时
200 SERACHPARAS_REQUIRED 接口路径搜索参数{serchParas}必填 NULL 当depth、type未提供或为空时

1.5. 注意事项:

1、根据传入节点往上或往下查找文件夹。

2、type为Parent只向上搜索,为Child只向下搜索,为Both同时向上下搜索。

3、depth为整数,如果小于0就是按照type设置遍历查询对应方向的全部层次节点;如果等于0则仅返回当前文件夹,如果大于0就往上或往下搜索{depth}层。

4、返回内容中分别使用parents、children标识返回节点的上层节点、下层节点。

5、如启用gacl则仅返回用户对节点有读权限的数据,例如 a-b-c-d四者关联,如用户没有c的读权限,则只返回a-b。

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

results matching ""

    No results matching ""