📢 Release Note: Simulation API v3

Release Date: 03 July 2025 

Version: Simulation API v3.0.1

• Added description to Location header for improved clarity on resource referencing.
• Renamed schema to common.portfolio for consistency across the API.
• Renamedversiontoartifact_versionin the configurations model and query parameters for clearer versioning semantics.
• Specified UUIDv4 format for identifiers such as jobId, configurationId, and exampleId to enforce standard UUID validation.
• Improve overall description of the API.

Release Date: 29 April 2025

Version: Simulation API v3.0.0

We are excited to announce the release of Simulation API v3, a major upgrade that introduces new capabilities, improved structure, and better alignment with RESTful standards. Despite the scope of changes, v3 is fully backward compatible, preserving all functionality from previous versions to ensure a smooth transition for existing users.

A dedicated migration guide is available in the documentation to help you move to v3 confidently.

🚀 What’s New in v3

✅ Improved Entry Point

• Added a new/home resource that lists available API operations relevant to the tenant, making navigation and discovery easier.

✅ Health Monitoring

• Introduced a/healthendpoint to programmatically check the health and availability of the Simulation API service.

✅ Tenant-Specific Configuration

• Added a/configurationsendpoint that provides detailed, tenant-specific configuration:
  • Available assets
  • Portfolio codes and descriptions
  • Supported computation modes

✅ RESTful Resource Naming & Structure

• Renamed/simulation/v0102to/portfolio-simulation-jobsto reflect REST resource naming conventions.
• Unified the synchronous and asynchronous simulation APIs into a single endpoint, using thecomputationModeparameter (sync,async, orlazy) to control execution behavior.

✅ Standardized API Documentation

• Provided a consistent, standardized API-level description at the top of the OpenAPI specification for better readability and tooling support.

✅ Cross-API Consistency

• Adopted common elements and design patterns from a shared API specification to improve consistency across all related APIs (e.g., allocation).

✅ Example Generation for Tenants

• Introduced endpoints to return tenant-specific example requests, helping new clients onboard more quickly with preconfigured payloads.

❌ Deprecated and Removed

• Removed the/versionendpoint, which was internal-only and used for backend application version identification.

🛠 Additional Update

Release Date: 12 May 2025

• Restructured the API Specification and Description:
  Separated the API Description from the OpenAPI Specification due to rendering limitations in the Developer Portal for long descriptive blocks.

📚 Need Help Migrating?
Check out the Simulation API v3 Migration Guide (link placeholder) in the documentation section.

For questions or support, feel free to reach out to the API team.