1. 获取指定管道构件之间的流向数据
获取两个构件管道间的流向数据。
请求方式:GET
请求地址:/api/{databaseKey}/piping/component/flowdirection?componentKey1={xxx}&componentKey2={xxx}&share={yyy}
1.1. 请求参数
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | 操作的通关令牌 |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
databaseKey | string | test | 是 | 数据库key,必传 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
componentKey1 | string | NULL | 是 | 起点构件key |
componentKey2 | string | NULL | 是 | 终点构件key |
share | string | NULL | 否 | 分享key |
Body
application/json:
NULL
1.2. 参数说明
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回
{
"message": "请求处理成功",
"code": "SUCCESS",
"data":
[
[
"M1543242343_323122",
"M1543242343_213123",
"M1543242343_367341",
... ...
],
... ... // 其他流向路径
]
}
1.4. 错误返回
状态码 | code | message | data | 原因 |
---|---|---|---|---|
NULL | BAD_PARAMETER | 参数componentKey1与componentKey2重复! | NULL | 参数componentKey1与componentKey2重复 |
NULL | COMPONENT_NOT_FOUND | 构件(xxx)不存在 | NULL | 参数componentKey1或componentKey2构件不存在 |
NULL | BosBizException | (xxx)和(xxx)不属于同一个模型 | NULL | 参数componentKey1或componentKey2不属于同一模型 |
1.5. 注意事项
- 返回结果构件列表中,由流向起点开始,连接到流向的终点构件。
- 两构件间有多条路径时,最多返回10条
- 数据库启用gacl时,有模型关联的BOSF文档读取权限的用户
- 数据库未启用gacl时,有数据库访问权限的用户
1.6. 备注
- 仅支持IFC模型和IFC模型的合并模型
- 支持两通及多通管道
- 此接口需要3.5以上版本的数据库支持