1. 获取模型族信息

查询模型中所有族及其包含的构件信息。


请求方式:GET

请求地址:/api/{databaseKey}/models/families?modelKey={modelKey}

1.1. 请求参数

Headers:

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

PathParas:

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

SearchParas:

参数名 类型 示例 是否必填 参数含义
modelKey string NULL 模型key

Body

application/json:

NULL

1.2. 参数说明

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

1.3. 正确返回

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "familyList": [ //族key列表
            "xxx",
            "xxx"
        ],
        "familyTree": { //族树结构
            "familyKey1": { //族key
                "familyName": "xxx", //族名称
                "components": [ //构件列表
                    {
                        "name": "xxx",
                        "key": "xxx"
                    },
          ... ...
                ],
                "subFamilyKey1": { //(二级)族key
                    "subFamilyName": "xxx",
                    "components": []
                }
            }
        }
    }
}

1.4. 状态码

状态码 code message data 原因
NULL NULL NULL NULL NULL

1.5. 备注

暂无备注

1.6. 注意事项

1、数据库启用gacl时,有模型关联的BOSF文档读取权限的用户。

2、数据库未启用gacl时,有数据库访问权限的用户。

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

results matching ""

    No results matching ""