1. 上传自定义模型树
上传用户自定义的模型树。
请求方式:POST
请求地址:/api/{databaseKey}/trees/custom
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
无参数 | NULL | NULL | NULL | NULL |
Body
application/json:
{
"modelKey": "M155702……",
"name": "系统树",
"content": {
"消防系统": {
"1F": [
{
"name": "xxx",
"key": "M155702……1"
},
{
"name": "xxx2",
"key": "M155702……2"
}
],
"2F": [
……
]
},
"家用冷水": {
"1F": [
……
],
"2F": [
……
]
}
}
}
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
modelKey | string | M1557022323 | 是 | 模型key |
name | string | 系统树 | 是 | 名字 |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"key": "xxxxx",
"modelKey": "M155702……",
"name": "系统树",
"fileKey":"xxxxxx"
}
}
1.4. 状态码
状态码 | code | message | data | 原因 |
---|---|---|---|---|
400 | BAD_PARAMETER_TYPE | 参数(content)类型不正确 | NULL | 当content不是JSONObject时 |
400 | COMPONENT_NOT_FOUND | 构件(xxx,yyy)不存在 | NULL | 当某个叶节点中有一个或多个构件不存在时 |
400 | PARSE_FAILED | 模型(xxxx)解析失败 | NULL | 当模型解析已经失败时 |
400 | PARSE_NOT_FINISHED | 模型(xxxx)正在解析 | NULL | 当模型解析尚未完成时 |
1.5. 备注
暂无备注
1.6. 注意事项
1、modelKey、name、content必填,不能为空。
2、content为用户定义的树结构(JSONObject类型),不包括根节点,叶节点为构件集合。
3、每个构件用一个JSONObject表示,属性包括key,name。
4、校验模型树每个叶节点中的构件key是否存在。
5、树结构数据保存至文件系统,fileKey为文件key。