Skip to content

Commit

Permalink
Add Force Resimulation API docs (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mythicaeda authored Mar 21, 2024
1 parent 487f0e3 commit 451f915
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/api/examples/simulation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,22 @@ query Simulate($planId: Int!) {
}
```

### Forcibly Rerun Simulation

Occasionally, there may be a need to resimulate a plan without changing any arguments,
for example if there was a network failure during a prior run.
In these cases, simulation can be forcibly rerun by providing the `force` argument to the `simulate` endpoint.

```graphql
query ForceResimulate($planId: Int!) {
simulate(planId: $planId, force: true) {
reason
simulationDatasetId
status
}
}
```

## Query for Simulation Results

The output of a simulation is stored in a `simulation_dataset`. A `simulation_dataset` has both profiles (aka states or resources), and simulated activities.
Expand Down

0 comments on commit 451f915

Please sign in to comment.