{"data":{"markdownRemark":{"html":"
\nNote: if you wish to modify variables in Globals please make sure any inputs are prefaced with system. or are contained within a system object.\n
\n

PUT

\n

Update the state of an interactive simulation

\n

Request

\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameLocated inDescriptionRequiredSchema
idpathID of interactive simulationYesstring
bodybodyOptional state to apply to simulationYesinline
\n

Example request

\n
curl -X PUT http://localhost:8080/api/simulations/interactive/{id} \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\"setup\": \"true\"}'
\n

Body Schema

\n

State will always be applied in the order it appears in this table, regardless of the order in request body.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
restartbooleanRestart the simulation, resetting all inputs and config to default values.
configobjectKey value object of config keys to update with values to update to.
inputobjectKey value object of input field to update with values to update to.
setupbooleanIf the simulation should be setup.
tickintegerTick to run to simulation to.
\n

Example request body

\n
{\n  \"restart\": true,\n  \"config\": { \"core.prng-seed\": 1 },\n  \"input\": { \"gridsize\": 20 },\n  \"setup\": true,\n  \"tick\": 10\n}
\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusMeaningDescriptionSchema
204No ContentRequest was completed successfullyNone
400Bad RequestRequest errorInline
404Not FoundSimulation not foundInline
409ConflictConflict completing request in current stateInline
500Internal Server ErrorInternal server errorInline
\n

Response Schema

\n

Status Code 400

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 400 response body

\n
{\n  \"message\": \"Could not handle message\"\n}
\n
\n

Status Code 404

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 404 response body

\n
{\n  \"message\": \"Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'\"\n}
\n
\n

Status Code 409

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 409 response body

\n
{\n  \"message\": \"Cannot set model tick for model that has not been setup.\"\n}
\n
\n

Status Code 500

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n
\n

GET

\n

Given the id, returns the interactive simulation object.

\n

Request

\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameLocated inDescriptionRequiredSchema
idpathID of simulationYesstring
\n

Example request

\n
curl -X GET http://localhost:8080/api/simulations/interactive/{id} \\\n  -H 'Accept: application/json'
\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusMeaningDescriptionSchema
200OKRequest was completed successfullyInline
404Not FoundSimulation not foundInline
\n

Response Schema

\n

Status Code 200

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
idstring(uuid)true
isStartedbooleantrueIs simulation ready to take requests
isBusybooleantrueIf simulation is currently busy processing, it cannot handle requests.
metadataobjecttrue
» schemaobjecttrueSchema of the simulation
» setupbooleantrueIf simulation has been setup.
» compileResultobjecttrue
\n

Example 200 response body

\n
{\n  \"id\": \"998436e0-a2df-427b-9c70-b07ba99a54fd\",\n  \"isStarted\": true,\n  \"isBusy\": false,\n  \"metadata\": {\n    \"kind\": \"pojo\",\n    \"schema\": {},\n    \"setup\": true,\n    \"compileResult\": {\n      \"hasErrors\": false,\n      \"hasWarnings\": false,\n      \"files\": {}\n    }\n  }\n}
\n
\n

Status Code 404

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 404 response body

\n
{\n  \"message\": \"Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'\"\n}
\n

DELETE

\n

Given the id, deletes the simulation.

\n

Request

\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameLocated inDescriptionRequiredSchema
idpathid of simulationYesstring
\n

Example request

\n
curl -X DELETE \\\n  http://localhost:8080/api/simulations/interactive/a098275a-307d-4d65-b8a5-47b9b484c609 \\\n  -H 'Cache-Control: no-cache'
\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusMeaningDescriptionSchema
204No ContentRequest was completed successfullyNone
404Not FoundSimulation not foundInline
\n

Response Schema

\n
\n

Status Code 404

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 404 response body

\n
{\n  \"message\": \"Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'\"\n}
","headings":[{"value":"PUT","depth":1},{"value":"Request","depth":2},{"value":"Parameters","depth":3},{"value":"Body Schema","depth":3},{"value":"Response","depth":2},{"value":"Response Schema","depth":3},{"value":"GET","depth":1},{"value":"Request","depth":2},{"value":"Parameters","depth":3},{"value":"Response","depth":2},{"value":"Response Schema","depth":3},{"value":"DELETE","depth":1},{"value":"Request","depth":2},{"value":"Parameters","depth":3},{"value":"Response","depth":2},{"value":"Response Schema","depth":3}],"frontmatter":{"title":"/api/simulations/interactive/{id}","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.5/rest_api/interactive/api_simulations_interactive_id.md","versioned":true,"version":"2.5","kind":"rest_api","pagePath":"/rest_api/interactive/api_simulations_interactive_id","chronology":{"prev":{"name":"/api/simulations/interactive/{id}/config","path":"/rest_api/interactive/api_simulations_interactive_config"},"next":{"name":"/api/simulations/interactive/{id}/ticks","path":"/rest_api/interactive/api_simulations_interactive_id_ticks"}},"lastUpdated":"2026-04-21T13:56:54.864Z"}}