跳到主要内容

OpenAPI 概览

ForeSim OpenAPI 用于运行已有场景、控制仿真实例、读取对象统计和结果表,以及读取动画、执行实例内 Groovy 脚本。场景建模与保存属于编辑器工作流。

进入接口测试页 · 从一次计算开始 · 认证与约定

22 项公开操作​

18 项主要操作与 4 项兼容操作均可在测试页选取、编辑和发送。对象、统计和结果表查询已经统一为名称契约,不再提供基于对象内部编号或带 by-name 后缀的重复接口。服务地址默认为 https://api.engine.foresim.top/api/simulation;在顶部填写该服务颁发的 API Key 后,页面直接调用接口。密钥仅在本页内存中使用,刷新后清除。未连接服务时可浏览结构示例,示例不代表运行结果。

分组操作数阅读入口
实例控制7实例控制
对象与统计4对象与统计
结果表3结果表
动画2动画
脚本执行2脚本执行
服务能力1服务能力
兼容接口5兼容接口

使用顺序​

先读取服务能力,确认场景权限,再创建实例并保存返回的 simulationId。需要对象 ID 或表 ID 时先发现,再明确选择。结果保存后释放实例。

脚本采用提交与查询两个操作:提交成功只确认受理,执行结果以 executionId 对应查询中的 status、result 和 error 为准。

本文档按当前公开路由、DTO 和 Schema 编写。环境是否启用、配额及运行结果由实际服务响应确认。接口测试不默认使用含 PLC 通信的案例场景。