---
title: "Set a test scenario"
method: PUT
path: "/scenario/{testid}"
tags: ["Test Setup"]
---

# Set a test scenario

`PUT /scenario/{testid}`

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.

## Request body

- object — Generic scenario payload.

## Response `200`

Successful response indicating the scenario was updated.

- object
  - `message` string
  - `payload` object — The applied scenario values (echo) or initial measurements if `time_period` triggers initialization.
  - `status` integer

## Changes

- **2026-02-02** `352c81bcd71d` — 2 info
  - api tag `Test Setup` added
  - api tag `Test Setup and Initialization` removed
- **2026-01-02** `e37b5217d73f` — 2 info
  - api tag `Test Setup and Initialization` added
  - api tag `meta` removed
- **2025-12-27** `611ed75d7a42` — 1 breaking, 5 warning
  - the `payload/additionalProperties/` response's property type/format changed from `string`/`` to ``/`` for status `200`
  - removed the request property `electricity_price`
  - removed the request property `seed`
  - removed the request property `solar_uncertainty`
  - …2 more
- **2025-12-27** `9bb743194905` — 1 breaking, 7 info
  - the `payload/additionalProperties/` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - api tag `meta` added
  - api tag `Test Setup` removed
  - added the new optional request property `electricity_price`
  - …4 more
- **2025-12-18** `e979b6db7bfd` — 1 breaking
  - request body became required

[Full history](https://skmtc.dev/ibpsa/apis/boptest-service-api/changes/scenario/:testid/put.md)

---

[API](https://skmtc.dev/ibpsa/apis/boptest-service-api.md) · [All operations](https://skmtc.dev/ibpsa/apis/boptest-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ibpsa/boptest-service-api/revisions/ecdfc7b011f7/schema)