---
title: "Set the test scenario"
method: PUT
path: "/scenario/{testid}"
tags: ["meta"]
---

# Set the test scenario

`PUT /scenario/{testid}`

Set the scenario for the running test. Optional properties may trigger an initialization (see README).

## Request body

- object
  - `electricity_price` string — Identifier for electricity price scenario.
  - `time_period` string — Named time period for scenario (may perform initialization).
  - `temperature_uncertainty` string — Temperature uncertainty setting.
  - `solar_uncertainty` string — Solar uncertainty setting.
  - `seed` integer — Random seed for scenario sampling.

## Response `200`

Successful response indicating the scenario was updated.

- object
  - `message` string
  - `payload` object — The applied scenario values (echo).
  - `status` integer

## Changes

- **2025-12-18** `e979b6db7bfd` — 1 breaking
  - request body became required
- **2025-11-18** `6f370686638c` — 1 info
  - api tag `meta` added
- **2025-11-18** `addf0e2239dd` — 1 info
  - endpoint added
- **2025-11-18** `60d61eda81c7` — 1 breaking
  - api removed without deprecation

[Change 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.dev/ibpsa/apis/boptest-service-api/revisions/e979b6db7bfd?raw)
