Test Setup

Set a test scenario

Set the scenario for the running test. Optional properties may trigger an initialization (see README). Typically, the supported scenario settings include:

electricity_price: "constant" or "dynamic" or "highly_dynamic"
time_period: "typical_heat_day" or "peak_heat_day"
temperature_uncertainty: "none" (null also acceptable) or "low" or "medium" or "high"
solar_uncertainty: "none" (null also acceptable) or "low" or "medium" or "high"
seed: int

However, this is partly test case specific. See the test case documentation for supported scenarios.

put/scenario/{testid}

Request body

object required

Generic scenario payload.

Response

Successful response indicating the scenario was updated.

messagestring

payloadobject

The applied scenario values (echo) or initial measurements if time_period triggers initialization.

statusinteger

Example response

{
  "message": "Scenario updated successfully.",
  "status": 200
}

Changes

Changed in 8 of the 17 revisions of this API.4513

Feb 2, 2026352c81bcd71d2See the full diff
- ○
  api tag Test Setup added
  api-tag-added
- ○
  api tag Test Setup and Initialization removed
  api-tag-removed
Jan 2, 2026e37b5217d73f2See the full diff
- ○
  api tag Test Setup and Initialization added
  api-tag-added
- ○
  api tag meta removed
  api-tag-removed
Dec 27, 2025611ed75d7a4215See the full diff
- ▲
  the / response's property type changed from string to no type for status
  response-property-type-changed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
Dec 27, 20259bb74319490517See the full diff
- ▲
  the / response's property type changed from no type to string for status
  response-property-type-changed
- ○
  api tag meta added
  api-tag-added
- ○
  api tag Test Setup removed
  api-tag-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 18, 2025e979b6db7bfd1See the full diff
- ▲
  request body became required
  request-body-became-required
Nov 18, 20256f370686638c1See the full diff
- ○
  api tag meta added
  api-tag-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 18, 2025addf0e2239dd1See the full diff
- ○
  endpoint added
  endpoint-added
Nov 18, 202560d61eda81c71See the full diff
- ▲
  api removed without deprecation
  api-removed-without-deprecation
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history