Foundation API

The Foundation API provides a low-level wrapper around the base functionality provided by the Server Layer SOAP API. As a result, a detailed knowledge of the Service Layer SOAP API is required, and care is needed around managing request size to achieve satisfactory performance and stability.

WARNING

The Foundation API is included for compatibility purposes only. The Streamlined API should be used for all new solutions.

WARNING

The Foundation API does not follow Semantic Versioning. Breaking changes may be introduced with any release and will in general not be documented.

Example notebooks

These example scripts show you how to use MI Scripting Toolkit to search for records, export data, and import data. All examples use the MI Training database, available from the Ansys Download Center.

Download all the notebooks and example files here, or access individual notebooks via the links in the navigation bar on the left.

API reference

The Foundation API is fully documented here.