1. 根据构件属性创建模型树
根据构件属性创建模型树。
请求方式:POST
请求地址:/api/{databaseKey}/trees
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
无参数 | NULL | NULL | NULL | NULL |
Body
application/json:
{
"modelKey": "M208081111", //模型key,必填
"name": "空间树", //树名称,必填
"groupAttributes": [
"attribute.约束.标高", //第1级
"type" //第2级
], //分组属性
"skipNull": false,
"fileKey":"xxxxxx"
}
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
modelKey | string | M208081111 | 是 | 模型key |
name | string | 空间树 | 是 | 树名称 |
attribute | string | NULL | 否 | 约束.标高 |
skipNull | Boolean | false | 否 | 分组属性 |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"key": "xxxxx",
"modelKey": "M208081111",
"name": "空间树",
"groupAttributes": [
"attribute.约束.标高", //第1级
"type", //第2级
],
"skipNull": false,
"fileKey": "xxxxxx"
}
}
1.4. 状态码
状态码 | code | message | data | 原因 |
---|---|---|---|---|
400 | BAD_PARAMETER_TYPE | 参数(groupAttributes)类型不正确 | NULL | 当groupAttributes不是列表时 |
400 | BAD_PARAMETER_TYPE | 参数(skipNull)类型不正确 | NULL | 当skipNull不是布尔值时 |
400 | PARSE_FAILED | 模型(xxxx)解析失败 | NULL | modelKey、name、content必填,不能为空。 content为用户定义的树结构(JSONObject类型),不包括根节点,叶节点为构件集合。 每个构件用一个JSONObject表示,属性包括key,name。 校验模型树每个叶节点中的构件key是否存在。 树结构数据保存至文件系统,fileKey为文件key,可通过2.10数据下载接口下载。 |
400 | PARSE_NOT_FINISHED | 模型(xxxx)正在解析 | NULL | 当模型解析尚未完成时 |
1.5. 备注
暂无备注
1.6. 注意事项
1、模型解析成功后才能创建树结构。
2、模型树支持多级结构,每一级的分组依据在groupAttributes属性中依次定义。
3、modelKey、name、groupAttributes必填,不能为空。
4、skipNull可选,如构件的分组属性不存在,是否忽略。默认为false,如构件对应分组属性值不存在,则归入<未分组>。
5、树结构数据保存至文件系统,fileKey为文件key。