APIs

1. SysML v2 Standard REST APIs

The SysML v2 API isn’t fully available yet, but we’re actively developing it. In the meantime, you can use the provided file exchange format to ensure interoperability with SysON.

SysON focuses on enabling seamless collaboration within the Model-Based Systems Engineering - MBSE ecosystem. With a strong emphasis on interoperability, SysON aims to support future standard APIs that will connect to a wide range of modeling tools and resources.

Although we’ve set standard API implementation as a key development goal, SysON already provides a solid foundation for effective collaboration between tools, reinforcing its role as a powerful platform for MBSE practitioners.

SysON’s commitment to incorporating standard REST APIs and SysML v2 textual specifications highlights its dedication to delivering a flexible and interoperable modeling solution.

Refer to the API Details Section for more information about the supported APIs.

2. APIs Cookbook

For detailed examples, best practices, and guidance on using SysON’s REST APIs, consult the APIs Cookbook. The cookbook includes:

  • Step-by-step guides for common tasks.

  • Code snippets for API interactions.

  • Explanations of core API concepts.