1. 创建图纸场景
根据图纸图层或图元属性创建新场景。
请求方式:POST
请求地址:/api/{databaseKey}/drawings/scenes
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | 是 | NULL |
Body
application/json:
{
"name":"图纸场景",
"drawingKey":"14323234",
"condition": [
{
"field": "layer",
"operator": "==",
"value": "xxxx",
},
{
"logic": "or",
"field": "property.其他.句柄",
"operator": "==",
"value": "1G"
}
]
}
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
file | file | NULL | 是 | 二三维关系文件 |
drawingKey | string | 234325 | 是 | 图纸key |
modelKey | string | M1244352634 | 是 | 模型key |
1.3. 正确返回
{
"code":"SUCCESS",
"message":"请求处理成功",
"data": {
"name": "图纸场景",
"type": "scene",
"pkgKey": "M1620377614239",
"treeKey": "Z3JvdXAzLE00RC8wMS8......",
"info": "Z3JvdXAzLE......",
"components": [
"Z3JvdXAzLE00RC8w......"
],
"geometries": [
"Z3JvdXAzLE00RC8w......"
]
}
}
1.4. 状态码
状态码 | code | message | data | 原因 |
---|---|---|---|---|
400 | PARAMETER_REQUIRED | 参数(name)不可为空 | NULL | 当参数name未指定时 |
400 | PARAMETER_REQUIRED | 参数(drawingKey)不可为空 | NULL | 当参数drawingKey未指定时 |
400 | PARAMETER_REQUIRED | 当参数condition未指定或为空时 | 当参数condition未指定或为空时 | |
400 | BAD_PARAMETER | condition节点必须包含field、operator和value; | NULL | 当condition中的节点缺少field、operator或value字段时 |
400 | BAD_PARAMETER | condition节点operator为like时,value必须为字符串 | NULL | 当operator为like,value不是字符串时 |
400 | BAD_PARAMETER | condition节点operator为{operator }时,value必须为数组 | NULL | 当opertor为in或not in,value不是数组时 |
1.5. 备注
1)数据库启用gacl时,有模型关联的BOSF文档读取权限的用户
2)数据库未启用gacl时,有数据库访问权限的用户
1.6. 注意事项
1)name必填
2)drawingKey必填
3)condition不能为空,每个过滤条件设置如下:
Ø field:表示查询字段,可以为字段名(如layer)或者对象字段的具体属性(如property.其他.句柄)
Ø operator:表示比较运算符,支持==、!=、<、<=、>、>=、like、in、not in
Ø value:表示值。如operator为like,则value应为字符串;如operator为in或not in,则value应为列表;其他情况可以为字符串、数字或null
Ø logic:表示与上一个条件之间的逻辑关系,可不填,默认为and