1. 根据{entity}获取的由根节点开始的完整树形结构数据

根据对象类获取由根节点开始的完整空间/系统树形分解结构。

请求方式:GET

请求地址:/bosfoundationservice/{appKey}/prototype/query/tree/{entity}/all

1.1. 请求参数:

Headers:

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

PathParas:

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

SearchParas:

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

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"    //第三层节点的对象具体属性信息
                        }
                    ]
                }
            ]
        }
    ]
}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_BOSCLASS_NOTFOUND 实体类{entity}不存在 NULL 当传入{entity}错误时
200 BOSCLASS_NA 不适用于{entity}类型实例数据 NULL 当对relationship类型操作时
200 CLASS_READPERMISSION_REQUIRED 缺少实体类{bosclass}的读权限 NULL 当实体启用了类权限,但当前用户没有实体的读权限时

1.5. 注意事项:

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

2、获取指定{entity}类型由根节点开始的完整树结构,若对某一分支的某一节点没有r权限,则此节点及之后的子节点无法查看。

3、树结构所有的节点均为{entity}类型或继承{entity}的子类型。

1.6. 请求示例

请求URL

http://bosgw.bimwinner.com/bosfoundationservice/{appKey}/prototype/query/tree/uotest11111/all

Headers

Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8

Body(application/json)

null

正常响应 200

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": []
}
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""