bims-service服务
服务概述
BIMS提供构件的属性查询接口。在不进行模型加载的前提下，实现模型属性信息的查询。
1.查询数据子集
GET /bims-api/bims/v2/subdatas
查询当前clientid(token中clientid需拥有admin)的数据子集，没传clientid取token的clientid
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| clientId |
query |
string |
是 |
|
| externalId |
query |
string |
是 |
关联外部id，可通过查询转换状态接口返回的translation_bucket_name 和translation_Key拼接而成 |
externalId格式为：
urn:bimbox.object:{translation_bucket_name}/{translation_Key}
如
urn:bimbox.object:translation_result_v2/3OB3uc3aMoGL3TrLLv26NHft
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
SubDataListApiResponse |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas
HTTP响应示例
响应200
{
"message": "string",
"result": [
{
"bimBoxJobId": "string",
"bimBoxUrl": "string",
"centerx": 1.0,
"centery": 1.0,
"centerz": 1.0,
"clientId": "string",
"creationAt": "string",
"delFileOnSuccess": true,
"description": "string",
"devOpsUrl": "string",
"discipline": "string",
"extendData": {},
"externalId": "string",
"height": 1.0,
"id": "string",
"name": "string",
"rotatex": 1.0,
"rotatey": 1.0,
"rotatez": 1.0,
"subDataStatus": {},
"subDataType": {},
"token": "string",
"versionNo": 0,
"xdbType": 0
}
],
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
array |
否 |
业务结果 |
| success |
boolean |
否 |
业务请求是否成功 |
2.获取数据子集下的构件
GET /bims-api/bims/v2/subdatas/{subDataId}/components
根据subDataId获取数据子集下的构件
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| versionNo |
query |
string |
否 |
版本号，默认为0，表示当前最新的版本 |
| subDataId |
path |
string |
是 |
数据子集id，查询数据子集返回的 "id" |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
BimsComponentListApiResponse |
| 404 |
Not Found |
application/json |
ProblemDetails |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas/{subDataId}/components
HTTP响应示例
响应200
{
"message": "string",
"result": [
{
"className": "string",
"classNamespace": "string",
"componentCode": "string",
"geometryId": "string",
"id": "string",
"isShell": true,
"name": "string",
"props": {},
"subDataId": "string",
"transformer": "string",
"versionNo": 0,
"xdbGuid": "string"
}
],
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
array |
否 |
业务结果 |
| success |
boolean |
否 |
业务请求是否成功 |
3.批量获取构件
POST /bims-api/bims/v2/subdatas/{subDataId}/components/batchget
根据数据子集id及多个构件id获取多个构件信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| versionNo |
query |
string |
否 |
|
| subDataId |
path |
string |
是 |
数据子集id，查询数据子集返回的 "id" |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
BimsComponentListApiResponse |
| 404 |
Not Found |
application/json |
ProblemDetails |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas/{subDataId}/components/batchget
请求体
类型: application/json
引用模型:ComponentIdsRequestDto
请求体示例
{
"componentIds": [
"string"
]
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| componentIds |
array |
否 |
构件xdbGuid 集合，无xdbGuid值时，无实际返回 |
HTTP响应示例
响应200
{
"message": "string",
"result": [
{
"className": "string",
"classNamespace": "string",
"componentCode": "string",
"geometryId": "string",
"id": "string",
"isShell": true,
"name": "string",
"props": {},
"subDataId": "string",
"transformer": "string",
"versionNo": 0,
"xdbGuid": "string"
}
],
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
array |
否 |
业务结果 |
| success |
boolean |
否 |
业务请求是否成功 |
4.构件搜索
POST /bims-api/bims/v2/subdatas/{subDataId}/components/search
支持构件名称模糊查询，参数：componentName 大小写不敏感
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| versionNo |
query |
string |
否 |
|
| subDataId |
path |
string |
是 |
数据子集id，查询数据子集返回的 "id" |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
BimsComponentListApiResponse |
| 400 |
Bad Request |
application/json |
ProblemDetails |
| 404 |
Not Found |
application/json |
ProblemDetails |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas/{subDataId}/components/search
请求体
类型: application/json
引用模型:ComponentConditionRequestDto
请求体示例
{
"classname": "string",
"componentName": "string",
"propsConditions": [
{
"key": "string",
"operateSymbol": 0,
"value": {}
}
],
"spacename": "string"
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| classname |
string |
是 |
构件所属类名称 |
| componentName |
string |
是 |
构件名称 |
| propsConditions |
array：ComponentSelectCondition |
否 |
属性搜索表达式集合 |
| spacename |
string |
是 |
构件所属命名空间名称 |
ComponentSelectCondition说明
| 名称 |
类型 |
必填 |
描述 |
| key |
string |
false |
键 |
| operateSymbol |
integer |
false |
0:大于，1:大于等于，2:小于，3:小于等于，4:等于，5:不等于，6:模糊匹配 |
| value |
null |
false |
值 |
| needToLong |
boolean |
false |
是否转long类型 |
HTTP响应示例
响应200
{
"message": "string",
"result": [
{
"className": "string",
"classNamespace": "string",
"componentCode": "string",
"geometryId": "string",
"id": "string",
"isShell": true,
"name": "string",
"props": {},
"subDataId": "string",
"transformer": "string",
"versionNo": 0,
"xdbGuid": "string"
}
],
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
array |
否 |
业务结果 |
| success |
boolean |
否 |
业务请求是否成功 |
5.获取指定构件
GET /bims-api/bims/v2/subdatas/{subDataId}/components/{componentId}
根据数据子集id及构件id获取指定构件信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| versionNo |
query |
string |
否 |
|
| subDataId |
path |
string |
是 |
数据子集id，查询数据子集返回的 "id" |
| componentId |
path |
string |
否 |
构件xdbGuid |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
BimsComponentApiResponse |
| 404 |
记录不存在 |
application/json |
|
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas/{subDataId}/components/{componentId}
HTTP响应示例
响应200
{
"message": "string",
"result": {
"className": "string",
"classNamespace": "string",
"componentCode": "string",
"geometryId": "string",
"id": "string",
"isShell": true,
"name": "string",
"props": {},
"subDataId": "string",
"transformer": "string",
"versionNo": 0,
"xdbGuid": "string"
},
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
object: BimsComponent |
否 |
None |
| success |
boolean |
否 |
业务请求是否成功 |
组织关系树
6.获取数据子集的组织关系树列表
GET /bims-api/bims/v2/subdatas/{subDataId}/orgtrees
获取数据子集的组织关系树列表
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| subDataId |
path |
string |
是 |
数据子集id，查询数据子集返回的 "id" |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
OrgnazitionalTreeListApiResponse |
| 400 |
Bad Request |
application/json |
ProblemDetails |
| 404 |
Not Found |
application/json |
ProblemDetails |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas/{subDataId}/orgtrees
HTTP响应示例
响应200
{
"message": "string",
"result": [
{
"creationAt": "string",
"id": "string",
"organizationalType": 0,
"schemaName": "string",
"subDataId": "string",
"treeType": 0
}
],
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
array |
否 |
业务结果 |
| success |
boolean |
否 |
业务请求是否成功 |
7.获取组织关系树节点数据
GET /bims-api/bims/v2/subdatas/{subDataId}/orgtrees/{orgTreeId}/nodes
如果componentId不为null，则获取从componentId节点开始的子树节点数据
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| componentId |
query |
string |
否 |
子树根节点ID |
| versionNo |
query |
string |
否 |
版本号 默认为0,调用最新的版本 |
| subDataId |
path |
string |
是 |
数据子集id，查询数据子集返回的 "id" |
| orgTreeId |
path |
string |
是 |
组织树id，获取数据子集的组织关系树列表返回的 "id" |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
Success |
application/json |
OrgnazitionNodeListApiResponse |
| 404 |
Not Found |
application/json |
ProblemDetails |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bims-api/bims/v2/subdatas/{subDataId}/orgtrees/{orgTreeId}/nodes
HTTP响应示例
响应200
{
"message": "string",
"result": [
{
"creationAt": "string",
"id": "string",
"name": "string",
"nodeClassName": "string",
"nodeId": "string",
"nodeNamespace": "string",
"nodeType": 0,
"orgnazitionalTreeID": "string",
"parentNodeClassName": "string",
"parentNodeId": "string",
"parentNodeNamespace": "string",
"userLable": "string",
"versionNo": 0
}
],
"success": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| message |
string |
否 |
错误信息 |
| result |
array |
否 |
业务结果 |
| success |
boolean |
否 |
业务请求是否成功 |
