v1

latestOpenAPI 3.0.32026-07-1718922.1 KB

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
}