Skip to main content

Execute

POST 
/scenarios/:scenarioId/execute

Dispatches the scenario for execution using the Envizage Query Language. This is the step where the simulation of the household will be run and the results recorded.

The payload accepts JSON expressions using the Envizage Query Language specification. The language specification can be found in the Simulation Results section.

It returns HTTP 200 if the execution was dispatched successfully.

To retrieve the simulation results, please refer to the Simulation Results section.

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

Query Parameters

    resultMode string

    Possible values: [NOMINAL, REAL]

    Default value: NOMINAL

    Simulation result mode

Body

required
  • string

Responses​

OK

Schema
  • string
Loading...