API Changelog
While we endeavour not to change the API in a backwards-incompatible way, this is not always possible. This page contains a history of changes to the API.
- Production
- These changes are live in both production and staging environments.
- Staging
- Changes marked with this badge are already live in the staging environment, but have not yet been released in the production environment. The date represents when the change will become available in production.
- Not yet released
- These changes are not yet available in either environment, but are included to warn of an upcoming change to the API.
To learn more about our environments, see the introduction to the API.
3rd May 2022
- The scenario
protected
attribute is deprecated and has been split into two separate attributes:read_only
andkeep_compatible
. Theprotected
attribute continues to be supported as an alias ofread_only
, and scenarios marked asprotected
will behave as they did before.
5th April 2022
Scenarios should no longer be given a
title
ordescription
attribute. If you wish to store such data with your scenarios, please use the scenario metadata.{
"scenario": {
"metadata": {
"title": "My scenario"
}
}
}For the moment,
title
anddescription
continue to be supported, and will result in the corresponding metadata keys being set. This feature will be removed later in May 2022.Example requestPUT /api/v3/scenarios/12345 HTTP/2
Host: engine.energytransitionmodel.com
Accept: application/json
{
"scenario": {
"title": "My scenario",
"description": "A description"
},
"detailed": true
}Example response{
"id": 12345,
// ...
"title": "My scenario",
"description": "A description"
"metadata": {
"title": "My scenario",
"description": "A description"
}
}
1st February 2022
- Scenarios marked as
protected
are now read-only. Changes to a protected scenario are not permitted and will be rejected with a 403 Forbidden response. Read more → - Inputs may now contain a
disabled_by
attribute which lists other input keys in an array. The input will be disabled if any of the specified inputs have a value provided by the user. Read more → - Old node endpoints
/api/v3/converters
and/api/v3/converters/{node_id}
have been removed. You can still access this data by first creating a scenario.