3.0.x

Below you can find explanations of breaking and otherwise notable changes in this release. For a complete list of changes please refer to 📖 CHANGELOG.md and 📚 openapi.yaml in the repository.

For the planned release timeline and a full list of changes (including GUI features) please refer to the 📄 Release Notes article in the ❓Help / FAQ.

🚨 Breaking Changes

Filtering for multiple enum values in Auction Schedule and Auction Results

As per multiple Participant requests the query parameters for retrieving the Auction Schedule and Auction Results has been uniformised to support multiple values for both internal and public endpoints.

Multiple values are always joined with an OR logical operator and can be specified by repeating the query parameter the desired times. For example you can send the GET /v1/auctions?timescales=LONG_TERM&timescales=DAY_AHEAD request to get a list of scheduled Long Term OR Day Ahead Auctions.

The following parameters has been renamed:

OperationId	Path	Old Parameter ❌	New Parameter ✅
getAuctions	GET /v1/auctions	timescale productType status	timescales productTypes statuses
getAllocatedAuctions	GET /v1/allocated-auctions	timescale	timescales
getAggregatedAllocatedAuctions	GET /v1/allocated-auctions/aggregated	timescale	timescales
getPublicAuctions	GET /v1/public/auctions	timescale productType status	timescales productTypes statuses
getPublicAllocatedAuctions	GET /v1/public/allocated-auctions	timescale	timescales
getPublicAggregatedAllocatedAuctions	GET /v1/public/allocated-auctions/aggregated	timescale	timescales

Query Allocation Results Report by "Display ID"

The getAuctionAllocationResultsReport (which fetches allocation results in "ECAN Allocation Results Document v4.0" format) now supports querying by both an "Internal ID" or a "Display ID".

• Internal ID
  • in UUIDv4 format, can be obtained from the browser URLs or the id field of an Auction object
  • example: 76a8072b-3fdd-459c-8f4a-3b443424d7ac
• Display ID
  • shown on the GUI, or can be obtained from the displayId field of an Auction object
  • example: BDL-NL-GB-M-BASE---240401-01

This change is only breaking integrations, if you are using the 🐍 Python Client SDK or otherwise utilise code generation based on the published 📚 openapi.yaml file, as only the internal parameter name has been changed from id to idOrDisplayId, the request path uses the same schema as GET /v1/reporting/auctions/<ID>/allocation-results.