工具文档
共 91 个工具,覆盖 CATIA V5 与 PLM建筑与基础设施两大模块
目前AI可以落地的,帮助工程师完成一些自动化和批量化的任务,例如实例化超级副本等模板,导出工程数据,数据的输入输出
在生成设计图纸这一项中,自动创建工程图框,插入2D部件,一些固定化的标注和注释生成,可以做一些批量的标注属性修改,
因为接口限制,虽然有很多不完善的地方,是经过日积月累,会为我们的工作带来很大的便利性
catia_connect
建立与 CATIA V5 应用程序的连接会话
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
host | string | — | CATIA 主机地址,默认 localhost |
port | number | — | CATIA 通信端口 |
# 连接本地 CATIA
{
"host": "localhost",
"port": 8099
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sessionId | string | 会话唯一标识 |
catiaVersion | string | CATIA 版本号 |
status | string | 连接状态:connected |
catia_status
查询当前 CATIA 连接状态、活动文档及应用程序信息
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
# 查看 CATIA 连接状态
{}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
connected | boolean | 是否已连接 |
activeDocument | string | 当前活动文档名称 |
openDocuments | array[string] | 已打开的文档列表 |
new_part
在 CATIA 中创建一个新的 Part 文档
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partName | string | — | 零件名称,默认 Part1 |
# 新建零件文档
{
"partName": "MyNewPart"
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partId | string | 零件唯一 ID |
partName | string | 零件名称 |
new_part_timestamp
创建带时间戳命名的新 Part 文档,避免命名冲突
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
prefix | string | — | 零件名称前缀,默认 Part |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partId | string | 零件唯一 ID |
partName | string | 带时间戳的零件名称 |
timestamp | string | 时间戳字符串 |
save_current_document
保存当前 CATIA 活动文档到指定路径
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | — | 保存路径。为空则覆盖当前文件 |
# 另存为指定路径
{
"path": "D:/Parts/MyPart.CATPart"
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
savedPath | string | 实际保存路径 |
documentName | string | 文档名称 |
create_point
在活动零件中创建一个参考点,支持绝对坐标和偏移方式
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
x | number | 必填 | X 坐标 mm |
y | number | 必填 | Y 坐标 mm |
z | number | 必填 | Z 坐标 mm |
# 在 (100, 50, 0) 位置创建点
{
"x": 100,
"y": 50,
"z": 0
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
pointId | string | 点对象 ID |
position | object | 实际坐标 {x, y, z} |
create_sphere_surface ★
在活动零件中创建球体曲面,支持指定球心和半径
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center | object | — | 球心坐标。为空则默认原点 {x:0, y:0, z:0} |
x | number | — | 球心 X 坐标 mm |
y | number | — | 球心 Y 坐标 mm |
z | number | — | 球心 Z 坐标 mm |
radius | number | 必填 | 球体半径 mm |
# 在原点创建半径 50mm 的球体曲面
{
"radius": 50
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
surfaceId | string | 曲面对象 ID |
radius | number | 球体半径 mm |
center | object | 球心坐标 {x, y, z} |
create_cylinder_surface
在活动零件中创建圆柱曲面,支持指定圆心轴、半径和高度
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
radius | number | 必填 | 圆柱半径 mm |
height | number | 必填 | 圆柱高度 mm |
center | object | — | 底面圆心坐标,默认 {x:0, y:0, z:0} |
axis | string | — | 轴线方向:x / y / z,默认 z |
# 创建半径 30mm、高 80mm、Z 轴圆柱曲面
{
"radius": 30,
"height": 80,
"axis": "z"
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
surfaceId | string | 曲面对象 ID |
radius | number | 圆柱半径 mm |
height | number | 圆柱高度 mm |
create_offset_plane
在活动零件中创建偏移参考平面
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
reference | string | 必填 | 参考平面:xy / yz / zx |
offset | number | 必填 | 偏移距离 mm,可为负值 |
# 从 XY 平面偏移 50mm 创建新平面
{
"reference": "xy",
"offset": 50
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
planeId | string | 平面对象 ID |
reference | string | 参考平面 |
offset | number | 偏移距离 mm |
new_part_with_sphere ★
一键创建新零件并生成球体曲面,是最快捷的建模入口
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partName | string | — | 零件名称,默认 Part1 |
radius | number | 必填 | 球体半径 mm |
center | object | — | 球心坐标,默认原点 {x:0, y:0, z:0} |
# 新建零件并创建半径 100mm 的球体
{
"partName": "Ball",
"radius": 100
}
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partId | string | 零件 ID |
partName | string | 零件名称 |
surfaceId | string | 球体曲面 ID |
radius | number | 球体半径 mm |
extract_faces_with_color
根据颜色提取零件中的面,用于按颜色筛选几何元素
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
color | string | 必填 | 目标颜色名称或 RGB 值 |
bodyName | string | — | 指定几何体名称,为空则搜索全部 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
faceCount | number | 提取的面数量 |
faceIds | array[string] | 提取的面对象 ID 列表 |
create_gsd_line
在 GSD 创成式外形设计中创建直线元素
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
startPoint | string | 必填 | 起点参考或坐标 |
endPoint | string | 必填 | 终点参考或坐标 |
lineType | string | — | 直线类型:point-point / point-direction |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
lineId | string | 直线对象 ID |
length | number | 直线长度 mm |
create_circle
在创成式外形设计中创建圆或圆弧曲线
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
center | string | 必填 | 圆心点参考 |
radius | number | 必填 | 圆半径 mm |
support | string | — | 支撑平面或曲面 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
circleId | string | 圆对象 ID |
radius | number | 圆半径 mm |
create_loft
通过多个截面曲线创建放样曲面
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sections | array[string] | 必填 | 截面曲线 ID 列表 |
guides | array[string] | — | 引导线 ID 列表 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
loftId | string | 放样曲面对象 ID |
sectionCount | number | 截面数量 |
create_fill
通过边界曲线创建填充曲面
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
boundaries | array[string] | 必填 | 边界曲线 ID 列表 |
passingPoint | string | — | 穿过点参考 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
fillId | string | 填充曲面对象 ID |
create_join_elements
将多个曲线或曲面元素连接为一个整体
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
elements | array[string] | 必填 | 要连接的元素 ID 列表 |
tolerance | number | — | 合并公差 mm,默认 0.001 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
joinId | string | 连接后对象 ID |
elementCount | number | 连接的元素数量 |
create_projection_curve
将曲线投影到支撑曲面上创建投影曲线
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curve | string | 必填 | 要投影的曲线 ID |
support | string | 必填 | 支撑曲面 ID |
direction | string | — | 投影方向,默认沿法线 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
projectionId | string | 投影曲线 ID |
create_intersection_curve
计算两个几何体的交线
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
firstElement | string | 必填 | 第一个几何元素 ID |
secondElement | string | 必填 | 第二个几何元素 ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
intersectionId | string | 交线对象 ID |
create_surface_offset_tool
创建曲面的偏置/偏移曲面
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | 要偏移的曲面对象 ID |
offset | number | 必填 | 偏移距离 mm,可为负值 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
offsetSurfaceId | string | 偏移曲面对象 ID |
offsetDistance | number | 偏移距离 mm |
create_extract_surface
从几何体中提取指定的面或边界
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
faceId | string | 必填 | 要提取的面 ID |
propagationType | string | — | 传播类型:point / tangent / none |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
extractId | string | 提取的曲面对象 ID |
create_sweep
沿引导线扫描截面轮廓创建扫掠曲面
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
profile | string | 必填 | 截面轮廓曲线 ID |
guideCurve | string | 必填 | 引导曲线 ID |
sweepType | string | — | 扫掠类型:explicit / linear / circle |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sweepId | string | 扫掠曲面对象 ID |
create_trim_surface
用曲线或曲面修剪另一个曲面
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
surface | string | 必填 | 被修剪的曲面对象 ID |
trimElement | string | 必填 | 修剪元素(曲线或曲面)ID |
keepSide | string | — | 保留侧:left / right |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
trimmedSurfaceId | string | 修剪后曲面对象 ID |
create_sketch
在指定平面上创建一个新的草图
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | 草图平面:xy / yz / zx 或平面 ID |
sketchName | string | — | 草图名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sketchId | string | 草绘对象 ID |
sketchName | string | 草图名称 |
sketch_open
打开已有草图进入编辑模式
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketchId | string | 必填 | 草图对象 ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sketchId | string | 草图对象 ID |
status | string | 编辑状态 |
sketch_add_line
在活动草图中添加直线段
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
startX | number | 必填 | 起点 X 坐标 mm |
startY | number | 必填 | 起点 Y 坐标 mm |
endX | number | 必填 | 终点 X 坐标 mm |
endY | number | 必填 | 终点 Y 坐标 mm |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
lineId | string | 直线对象 ID |
length | number | 直线长度 mm |
sketch_add_circle
在活动草图中添加圆
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
centerX | number | 必填 | 圆心 X 坐标 mm |
centerY | number | 必填 | 圆心 Y 坐标 mm |
radius | number | 必填 | 圆半径 mm |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
circleId | string | 圆对象 ID |
radius | number | 圆半径 mm |
sketch_add_rectangle
在活动草图中添加矩形
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
x1 | number | 必填 | 左上角 X 坐标 mm |
y1 | number | 必填 | 左上角 Y 坐标 mm |
x2 | number | 必填 | 右下角 X 坐标 mm |
y2 | number | 必填 | 右下角 Y 坐标 mm |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
rectangleId | string | 矩形对象 ID |
width | number | 宽度 mm |
height | number | 高度 mm |
sketch_add_arc
在活动草图中添加圆弧
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
centerX | number | 必填 | 圆心 X 坐标 mm |
centerY | number | 必填 | 圆心 Y 坐标 mm |
radius | number | 必填 | 圆弧半径 mm |
startAngle | number | — | 起始角度(度) |
endAngle | number | — | 终止角度(度) |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
arcId | string | 圆弧对象 ID |
close_sketch
退出草图编辑模式并保存草图
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sketchId | string | 草图对象 ID |
status | string | 退出状态 |
create_sketch_with_rectangle
一键创建草图并在其中绘制矩形
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | 草图平面 |
width | number | 必填 | 矩形宽度 mm |
height | number | 必填 | 矩形高度 mm |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sketchId | string | 草图对象 ID |
rectangleId | string | 矩形对象 ID |
create_sketch_with_circle
一键创建草图并在其中绘制圆
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
plane | string | 必填 | 草图平面 |
radius | number | 必填 | 圆半径 mm |
centerX | number | — | 圆心 X 坐标 mm,默认 0 |
centerY | number | — | 圆心 Y 坐标 mm,默认 0 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
sketchId | string | 草图对象 ID |
circleId | string | 圆对象 ID |
pad_from_sketch
将草图轮廓拉伸为实体(凸台)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketchId | string | 必填 | 草图对象 ID |
length | number | 必填 | 拉伸长度 mm |
direction | string | — | 拉伸方向:normal / reverse |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
padId | string | 凸台特征 ID |
length | number | 拉伸长度 mm |
pocket_from_sketch
将草图轮廓拉伸切除实体(凹槽)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketchId | string | 必填 | 草图对象 ID |
depth | number | 必填 | 切除深度 mm |
direction | string | — | 切除方向:normal / reverse |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
pocketId | string | 凹槽特征 ID |
depth | number | 切除深度 mm |
shaft_from_sketch
将草图轮廓绕轴线旋转生成实体(旋转体)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
sketchId | string | 必填 | 草图对象 ID |
angle | number | — | 旋转角度(度),默认 360 |
axis | string | — | 旋转轴线参考 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
shaftId | string | 旋转体特征 ID |
angle | number | 旋转角度(度) |
add_edge_fillet
对实体边进行倒圆角处理
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
edgeIds | array[string] | 必填 | 要倒圆角的边 ID 列表 |
radius | number | 必填 | 圆角半径 mm |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
filletId | string | 倒圆角特征 ID |
radius | number | 圆角半径 mm |
add_chamfer
对实体边进行倒角处理
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
edgeIds | array[string] | 必填 | 要倒角的边 ID 列表 |
length1 | number | 必填 | 倒角长度1 mm |
length2 | number | — | 倒角长度2 mm,默认同 length1 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
chamferId | string | 倒角特征 ID |
create_hole
在实体上创建孔特征
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
faceId | string | 必填 | 放置面 ID |
diameter | number | 必填 | 孔直径 mm |
depth | number | — | 孔深度 mm,为空则通孔 |
centerX | number | — | 孔中心 X 坐标 |
centerY | number | — | 孔中心 Y 坐标 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
holeId | string | 孔特征 ID |
diameter | number | 孔直径 mm |
create_shell
将实体抽壳为薄壁结构
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
thickness | number | 必填 | 壳厚度 mm |
faceIds | array[string] | — | 要移除的面 ID 列表 |
side | string | — | 抽壳方向:inward / outward |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
shellId | string | 抽壳特征 ID |
thickness | number | 壳厚度 mm |
create_block
快速创建长方体实体
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
length | number | 必填 | 长度 mm |
width | number | 必填 | 宽度 mm |
height | number | 必填 | 高度 mm |
origin | object | — | 原点坐标 {x, y, z} |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
blockId | string | 长方体特征 ID |
volume | number | 体积 mm³ |
create_cylinder
快速创建圆柱体实体
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
radius | number | 必填 | 圆柱半径 mm |
height | number | 必填 | 圆柱高度 mm |
center | object | — | 底面圆心坐标 {x, y, z} |
axis | string | — | 轴线方向:x / y / z,默认 z |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
cylinderId | string | 圆柱体特征 ID |
volume | number | 体积 mm³ |
open_document
打开指定路径的 CATIA 文档
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 必填 | 文档文件路径 |
readOnly | boolean | — | 是否只读打开,默认 false |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
documentName | string | 文档名称 |
documentType | string | 文档类型:Part / Product / Drawing |
close_document
关闭指定的 CATIA 文档
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
documentName | string | 必填 | 文档名称或索引 |
save | boolean | — | 关闭前是否保存,默认 false |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
closed | boolean | 是否成功关闭 |
documentName | string | 已关闭的文档名称 |
close_all_documents
关闭所有已打开的 CATIA 文档
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
saveAll | boolean | — | 关闭前是否全部保存,默认 false |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
closedCount | number | 已关闭的文档数量 |
list_open_documents
列出当前所有已打开的 CATIA 文档
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
documents | array[object] | 打开的文档列表 |
count | number | 打开的文档总数 |
set_active_document
将指定文档设置为当前活动文档
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
documentName | string | 必填 | 文档名称或索引 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
activeDocument | string | 当前活动文档名称 |
success | boolean | 是否成功激活 |
export_to_step
将当前文档导出为 STEP 格式文件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 必填 | 导出文件路径 |
version | string | — | STEP 版本:AP203 / AP214 / AP242 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
exportedPath | string | 导出文件路径 |
success | boolean | 是否导出成功 |
export_to_stl
将当前文档导出为 STL 格式文件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 必填 | 导出文件路径 |
quality | string | — | 导出质量:low / medium / high |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
exportedPath | string | 导出文件路径 |
triangleCount | number | 三角面数量 |
export_to_igs
将当前文档导出为 IGES 格式文件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 必填 | 导出文件路径 |
version | string | — | IGES 版本号 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
exportedPath | string | 导出文件路径 |
success | boolean | 是否导出成功 |
traverse_product_tree
遍历产品结构树,获取完整的产品层级信息
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
rootProduct | string | — | 根产品名称,默认当前活动文档 |
depth | number | — | 遍历深度,默认全部 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
productTree | object | 产品结构树 JSON |
nodeCount | number | 节点总数 |
export_bom
导出产品物料清单(BOM)到指定文件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 必填 | 导出文件路径(Excel 或文本) |
format | string | — | 导出格式:xlsx / csv / txt |
template | string | — | BOM 模板名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
exportedPath | string | 导出文件路径 |
itemCount | number | BOM 条目数量 |
hello
基础调试工具,返回问候信息
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
message | string | 问候消息 |
echo
回显输入信息,用于测试通信
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
text | string | 必填 | 需要回显的文本 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
echo | string | 回显的文本 |
info
获取系统信息和配置详情
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
systemInfo | object | 系统信息对象 |
config | object | 配置信息 |
connect
连接到 PLM 建筑与基础设施模块
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
server | string | — | 服务器地址 |
port | number | — | 端口号 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
connected | boolean | 是否连接成功 |
test
执行基础功能测试
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
passed | boolean | 测试是否通过 |
results | array | 测试结果详情 |
active-part
获取当前活动零件信息
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partName | string | 零件名称 |
partId | string | 零件ID |
settings
查看或修改系统设置
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | — | 设置项名称 |
value | any | — | 设置值(可选,为空则读取) |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
settings | object | 设置项信息 |
template
从模板创建零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
templateName | string | 必填 | 模板名称 |
params | object | — | 模板参数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
partId | string | 新建零件ID |
rename
重命名零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 零件ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
batch-rename
批量重命名零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partIds | array[string] | 必填 | 零件ID列表 |
pattern | string | 必填 | 命名模式 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
renamedCount | number | 重命名数量 |
rename-vb
使用 VBA 脚本重命名零件
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 零件ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
rename-object
重命名对象(几何体、特征等)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
objectId | string | 必填 | 对象ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
change-params-name
修改参数名称
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
paramId | string | 必填 | 参数ID |
newName | string | 必填 | 新名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
product
创建或操作产品结构
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
productName | string | 必填 | 产品名称 |
operation | string | — | 操作类型:create / add / remove |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
productId | string | 产品ID |
create-obj-to-part
创建对象到零件中
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 目标零件ID |
objectType | string | 必填 | 对象类型 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
objectId | string | 创建的对象ID |
list-params
列出零件中的所有参数
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | — | 零件ID,默认当前活动零件 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
params | array[object] | 参数列表 |
infra_bridge_wireframe_t1
生成桥梁线框模型
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
params | object | — | 桥梁参数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
wireframeId | string | 线框模型ID |
bridge-nest-net-lines
生成桥梁嵌套网格线
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
density | number | — | 网格密度 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
linesCount | number | 生成的线条数量 |
demo-hybrid
演示混合建模功能
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
result | string | 演示结果 |
udf-instantiate
实例化 UDF(超级副本)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udfName | string | 必填 | UDF名称 |
params | object | — | UDF参数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
instanceId | string | 实例ID |
udf-replace
替换 UDF 实例
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
instanceId | string | 必填 | 实例ID |
newUdfName | string | 必填 | 新UDF名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
export-udf-params
导出 UDF 参数
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udfName | string | 必填 | UDF名称 |
path | string | — | 导出路径 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
params | object | UDF参数 |
update-udf-params
更新 UDF 参数
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
udfName | string | 必填 | UDF名称 |
params | object | 必填 | 新参数值 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
update-params-db
更新参数到数据库
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
partId | string | 必填 | 零件ID |
params | object | 必填 | 参数数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
updated | boolean | 是否成功更新 |
kp-autorun
自动运行知识工程规则
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
executed | boolean | 是否执行成功 |
write_drawingtable_bridge_a1
写入 A1 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
write_drawingtable_bridge_a2a3
写入 A2/A3 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
write_drawingtable_bridge_a4a5
写入 A4/A5 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
write_drawingtable_bridge_a6
写入 A6 图纸表格(桥梁专用)
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
drawing-table
创建工程图表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
rows | number | 必填 | 行数 |
cols | number | 必填 | 列数 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
tableId | string | 表格ID |
drw-table-a1
创建 A1 图纸表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | — | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
tableId | string | 表格ID |
write-drawingtable-vb
使用 VBA 写入图纸表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
data | object | 必填 | 表格数据 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
written | boolean | 是否成功写入 |
excel-to-drawing
从 Excel 导入数据到图纸表格
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
excelPath | string | 必填 | Excel 文件路径 |
sheetName | string | — | 工作表名称 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
importedRows | number | 导入行数 |
set-cell-font
设置单元格字体样式
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
cellId | string | 必填 | 单元格ID |
fontName | string | — | 字体名称 |
fontSize | number | — | 字体大小 |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
hello1
测量查询模块测试工具1
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
message | string | 测试消息 |
hello2
测量查询模块测试工具2
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无入参 | |||
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
message | string | 测试消息 |
check
检查测量数据
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
objectId | string | 必填 | 对象ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
valid | boolean | 数据是否有效 |
get-distance
获取两点之间的距离
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
point1 | object | 必填 | 点1坐标 {x, y, z} |
point2 | object | 必填 | 点2坐标 {x, y, z} |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
distance | number | 距离 mm |
get-length
获取曲线或边的长度
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
curveId | string | 必填 | 曲线或边ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
length | number | 长度 mm |
get-point-coordinate
获取点的坐标
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
pointId | string | 必填 | 点ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
coordinate | object | 坐标 {x, y, z} |
del-dim
删除尺寸标注
入参
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
dimId | string | 必填 | 尺寸标注ID |
响应 data
| 字段 | 类型 | 说明 |
|---|---|---|
deleted | boolean | 是否成功删除 |