🛠 Additional Update

Release Date: 12 May 2025 

Version: Allocation API v3.0.0

• Separated API Specification and Description:
  Due to rendering constraints in the Developer Portal, the API description was split from the main OpenAPI specification document to improve usability.

Release Date: 03 July 2025 

Version: Allocation API v3.0.1

• Added description to Location header for improved clarity on resource referencing.
• Categorized POST portfolio construction and rebalance recommendation endpoints’ response examples into sync and async computation modes to align with simulation behavior.
• Improved example response for POST rebalance recommendation to better reflect actual async processing status.
• Renamed schema to common.portfolio for consistency across the API.
• Renamed version to artifact_version in the configurations model and query parameters for clearer versioning semantics.
• Updated / (root) endpoint to return a correlation-Id header to support tracing and diagnostics.
• Added optional header Is-cache-skipped to POST rebalance recommendation input to allow cache control.
• Included standard response headers in GET rebalance recommendation examples to enhance consistency.
• Specified UUIDv4 format for identifiers such as jobId, configurationId, and exampleId to enforce standard UUID validation.

---

📢 Release Note: Allocation API v3

Release Date: 29 April 2025

Version: Allocation API v3.0.0

---

We are excited to announce the release of Allocation API v3, a major upgrade that introduces new capabilities, improved endpoint structure, and enhanced RESTful design. Despite the scope of improvements, v3 is fully backward compatible, preserving all functionality from previous versions to ensure a smooth migration.

A comprehensive migration guide is available in the documentation to assist you during the upgrade process.

---

🚀 What’s New in v3

✅ Improved Entry Point

• Added a new / home resource that lists all available API operations relevant to the tenant, simplifying API navigation.

✅ Health Monitoring

• Introduced a /health endpoint to allow clients to programmatically check the API’s health and availability.

✅ Tenant-Specific Configuration

• Added /configurations endpoint exposing tenant-specific settings, including:
  • Available assets
  • Portfolio codes and descriptions
  • Supported computation modes

✅ RESTful Endpoint Renaming and Restructuring

• Renamed /recommendAllocation and /recommendAllocationAsync to:
  • /portfolio-construction-jobs
  • /rebalance-recommendation-jobs
• This change clearly separates portfolio construction from rebalancing recommendation workflows.
• Combined synchronous and asynchronous endpoints into a single unified endpoint, controlled via a computationMode parameter (sync, async, or lazy).

✅ Standardized API Documentation

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

✅ Consistency Across APIs

• Harmonized common elements with related APIs to ensure consistent behavior and design patterns across the platform.

✅ Tenant-Specific Example Requests

• Added endpoints to provide tenant-specific example payloads, facilitating easier onboarding and integration.

❌ Deprecated and Removed

• Removed the /version endpoint, which was intended for internal backend version tracking and is no longer exposed.

---

📚 Need Help Migrating?
Please refer to the Allocation API v3 Migration Guide for detailed instructions and best practices.

For questions or assistance, contact the API support team.