Class SimulationController
Controller for the REST interface for managing Simulation records.
Inherited Members
Namespace: Quantellia.WMServer.Simulation
Assembly: WMServer.dll
Syntax
[Route("simulation")]
[ApiController]
[Authorize]
public class SimulationController : ControllerBaseMethods
Delete(int)
Delete the Simulation record with the specified ID, along with all its data.
Declaration
[HttpDelete("{id}")]
public void Delete(int id)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | ID of the Simulation object to delete. |
Get(int)
Get the details of the Simulation with the specified ID.
Declaration
[HttpGet("{id}")]
public string Get(int id)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | ID of the Simulation to retrieve. |
Returns
| Type | Description |
|---|---|
| string | The full details of the requested Simulation record. |
GetAll(string)
Get the collection of Simulation records associated with the specified DecisionModel.
Declaration
[HttpGet("all/{decisionModelID}")]
public IEnumerable<string> GetAll(string decisionModelID)Parameters
| Type | Name | Description |
|---|---|---|
| string | decisionModelID |
Returns
| Type | Description |
|---|---|
| IEnumerable<string> | A collection of Simulation(string, EvaluationArgs) records represented as SimulationDTO objects. |
Put(int, string)
Update the Simulation record with the specified ID.
Declaration
[HttpPut("{id}")]
public void Put(int id, string value)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | ID of the Simulaiton record to update. |
| string | value | Object containing the values to be updated. |
Simulation(string, EvaluationArgs)
Create but do not run a new Simulation of a DecisionModel.
Declaration
[HttpPost("{id}")]
public Task<ActionResult<SimulationDTO>> Simulation(string id, EvaluationArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| string | id | ID of the DecisionModel to create the Simulation record for. |
| EvaluationArgs | args | Arguments that control the simulation. |
Returns
| Type | Description |
|---|---|
| Task<ActionResult<SimulationDTO>> | Returns a reference to the newly created Simulation object. |