1. 根据{entity}的{key}查询该节点的树形结构数据

根据对象类的Key查询该节点的树形结构数据。

请求方式：GET

请求地址：/bosfoundationservice/{appKey}/prototype/query/tree/{entity}/{key}?type={type}&depth={depth}

1.1. 请求参数：

Headers：

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

PathParas：

参数名	类型	示例	是否必填	参数含义
entity	string	locations	是	对象类类名
key	string	scdsf334345sdffsf	是	对象类Key

SearchParas：

参数名	类型	示例	是否必填	参数含义
type	string	Parent	是	搜索的方向，Parent只向上搜索，Child只向下搜索，Both同时向上下搜索
depth	string	1	是	搜索深度

Body：

application/json：

NULL

1.2. 参数说明：

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

1.3. 正确返回：

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

1.4. 状态码：

状态码	code	message	data	原因
200	ENTITY_BOSCLASS_NOTFOUND	实体类{entity}不存在	NULL	当传入{entity}错误时
200	BOSCLASS_NA	不适用于{entity}类型实例数据	NULL	当对relationship类型操作时
200	ENTITY_NOTFOUND	Key为{key}的{entity}实体对象不存在	NULL	当{key}对应的{entity}不存在时
200	ENTITY_READPERMISSION_REQUIRED	缺少实体对象{bosclass/key}的读权限	NULL	如{key}对应的{entity}无读权限
200	SEARCHPARAS_VALUE_INVALID	接口路径搜索参数{serchParas}值无效	NULL	当depth值非整数时
200	SEARCHPARAS_VALUE_INVALID	接口路径搜索参数{serchParas}值无效	NULL	当type不等于Parent、Child、Both中的任何一个时
200	SERACHPARAS_REQUIRED	接口路径搜索参数{serchParas}必填	NULL	当depth、type未提供或为空时
200	CLASS_READPERMISSION_REQUIRED	10) 当实体启用了类权限，但当前用户没有实体的读权限时	NULL	缺少实体类{bosclass}的读权限

1.5. 注意事项：

1、对象类指数据模型中配置的对象类。

2、根据传入节点往上或往下查找节点。

3、type为Parent只向上搜索，为Child只向下搜索，为Both同时向上下搜索。

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

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

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

1.6. 请求示例

请求URL

http://bosgw.bimwinner.com/bosfoundationservice/{appKey}/prototype/query/tree/uotest11111/7c311e5d36cc4fc583e719032c2b1073?type=Both&depth=1

Headers

Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8

Body（application/json）

null

正常响应 200

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "code": "53gO36krTUF02vwshFDmft",
        "level": 1,
        "leaf": true,
        "parentId": null,
        "guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
        "gtime": "1596779965707",
        "name": "tesParent",
        "guid": "7c311e5d36cc4fc583e719032c2b1073",
        "longCode": "7c311e5d36cc4fc583e719032c2b1073",
        "bosclass": "uotest11111",
        "key": "7c311e5d36cc4fc583e719032c2b1073",
        "gcreatetime": "1596779965707",
        "longName": "tesParent"
    }
}

查询某个节点的树结构对象类实例数据