1. 创建自定义场景

根据自定义的层次关系组织构件数据,创建层次化场景以便前端按层级加载。


请求方式:POST

请求地址:/api/{databaseKey}/scenes/custom

1.1. 请求参数

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea 操作的通关令牌

PathParas:

参数名 类型 示例 是否必填 参数含义
databaseKey string test 数据库key,必传

SearchParas:

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

Body

application/json:

{
    "name": "测试场景",
    "child": [
        {
            "name": "主楼",
            "child": [
                {
                    "name": "1层",
                    "itemType": "component",
                    "items": [
                        "1313058_1",
                        "1312396_9",
                        "1313058_1"
                    ]
                },
                {
                    "name": "2层",
                    "itemType": "component",
                    "items": [
                        "1368742_4",
                        "1313058_Z"
                    ]
                }
            ]
        },
        {
            "name": "裙楼",
            "itemType": "model",
            "items": [
                "1422266"
            ]
        }
    ],
    "docKey": "012e245f581788970""options": {
        "reduceMeshes": false
    }
}

1.2. 参数说明

参数名 类型 示例 是否必填 参数含义
name string 测试场景 名字
itemType string model 实体类型
items 数组 "1422266" 实体
options Boolean NULL options
docKey string 012e245f581788970 docKey

1.3. 正确返回

{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": {
        "key": "xx",
        "status": "xx",
        "remark": "xx"
    }
}

1.4. 状态码

状态码 code message data 原因
400 BAD_PARAMETER XXX NULL 当body不为空但参数错误时
400 BIZ_EXCEPTION modelKey为xxxx的模型几何正在转换中,请稍后再试 NULL 场景中同时包含2.0、3.0几何格式的模型,且几何格式是3.0的模型几何尚在转换中
400 BIZ_EXCEPTION modelKey为xxxx的模型未开始几何转换,构件几何不存在 NULL 场景中同时包含2.0、3.0几何格式的模型,且几何格式是3.0的模型几何尚未转换
400 BIZ_EXCEPTION modelKey为xxxx的模型的几何转换失败 NULL 场景中同时包含2.0、3.0几何格式的模型,且几何格式是3.0的模型几何转换失败

1.5. 备注

1、1.0版几何格式的模型或构件与2.0、3.0版几何格式不兼容。
2、此接口DWG图纸不适用。

1.6. 注意事项

1、场景涉及的模型解析完成后才可以创建自定义场景。
2、场景节点必须指定name。
3、场景节点必须指定child或items,且不能同时指定。
4、child中的元素为场景子节点,不能为空,可以嵌套。
5、items中的元素不能为空,且同一节点中不能重复。
6、docKey为场景对象对应的BOSF文档key,在数据库启用gacl时必填。
7、items、child不能为空
8、当场景中同时包含2.0、3.0几何格式模型时,校验3.0几何格式的模型几何转换是否完成
9、数据库启用gacl时,有模型关联的BOSF文档编辑权限的用户
10、数据库未启用gacl时,有数据库访问权限的用户
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-06 13:45:47

results matching ""

    No results matching ""