programs
Start the given program
By putting a program object to this endpoint, the system will try to start it if all preconditions are fulfilled:
- Home appliance is connected
- Remote Control and Remote Control Start Allowed is enabled
- No other program is currently active
Furthermore, the program must exist on the home appliance and its options must be set correctly. Keys of program, which can be exected on an oven, are for instance:
- Cooking.Oven.Program.HeatingMode.HotAir
- Cooking.Oven.Program.HeatingMode.TopBottomHeating
- Cooking.Oven.Program.HeatingMode.PizzaSetting
- Cooking.Oven.Program.HeatingMode.PreHeating
Keys for options of these oven programs are:
- Cooking.Oven.Option.SetpointTemperature: 30 - 250 °C
- BSH.Common.Option.Duration: 1 - 86340 seconds
For further documentation, visit the appliance-specific programs pages:
- Cleaning Robot
- Coffee Machine
- Cooktop
- Cook Processor
- Dishwasher
- Dryer
- Hood
- Oven
- Warming Drawer
- Washer
- Washer Dryer
There are no programs available for freezers, fridge freezers, refrigerators and wine coolers.
put/homeappliances/{haId}/programs/active
Request
- Base URL: https://simulator.home-connect.com/api
- URL: https://simulator.home-connect.com/api/homeappliances/{haId}/programs/active
- Auth: OAuth 2 (authorization code, authorization URL https://simulator.home-connect.com/security/oauth/authorize, token URL https://simulator.home-connect.com/security/oauth/token, scopes: Control, Oven-Control, Dishwasher-Control, Washer-Control, Dryer-Control, CoffeeMaker-Control, Hob-Control, Hood-Control, CleaningRobot-Control, WasherDryer-Control, Refrigerator-Control, Freezer-Control, WineCooler-Control, CookProcessor-Control, Oven, Dishwasher, Washer, Dryer, CoffeeMaker, Hob, Hood, CleaningRobot, WasherDryer, Refrigerator, Freezer, WineCooler, CookProcessor)
Response
The request was successful
Changes
No recorded changes to this operation across all 1 revision of this API.