{"data":{"markdownRemark":{"html":"

POST

\n

Creates and run a batch simulation and returns the object with its various attributes.

\n

Request

\n

Example request body

\n
curl -X POST \\\n  http://localhost:8080/api/simulations/batch \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"input\":{\"system\":{\"fillFactor\": 0.5}},\n\t\"ticks\": 300,\n\t\"runs\": 200,\n\t\"name\":\"Game of Life\"\n}'
\n

Body Schema

\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
namestringtrueName of model to create interactive simulation for
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.
runsintegertrueNumber of times to run full simulation.
ticksintegertrueNumber of ticks to run each simulation run to.
\n

Example request body

\n
{\n  \"input\": { \"system\": { \"fillFactor\": 0.5 } },\n  \"config\": {\n    \"core-abm-spark.master-url\": \"local[*]\",\n    \"core-abm-spark.log-level\": \"WARN\"\n  },\n  \"ticks\": 300,\n  \"runs\": 200,\n  \"name\": \"Game of Life\"\n}
\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusMeaningDescription
200OKSuccessfully created. The session ID is returned in a cookie named simudyneSessionID. You need to include this cookie in subsequent get requests.
404Not FoundSimulation not found.
\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
NameTypeRequiredDescription
idstring(uuid)true
namestringtrue
descriptionstringtrue
publicbooleantrue
sessionstring(uuid)truesimudyneSessionID cookie
kindstringtrue
\n

Example 200 response body

\n
{\n  \"id\": \"d7558ad9-3405-4a4c-972a-531a87fdcd27\",\n  \"name\": \"Game of Life\",\n  \"description\":\n    \"The Game of Life, also known simply as Life, is a cellular automaton devised by the British mathematician John Horton Conway in 1970.\",\n  \"public\": false,\n  \"session\": \"760b2d3e-20b2-42e6-9655-58e662e79e73\",\n  \"kind\": \"pojo\"\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\": \"SimulationRegistry: Could not find requested simulation default.\"\n}
\n
\n

GET

\n

Returns a list of running batch simulations for model

\n

Request

\n

Example request body

\n
curl -X GET \\\n  'http://localhost:8080/api/simulations/batch?name=Game%20of%20Life' \\\n  -H 'Cache-Control: no-cache'
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameLocated inDescriptionRequiredSchema
namequery paramName of modelYesstring
\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
StatusMeaningDescription
200OKSuccessfully created.
400Bad RequestRequest errorInline
404Not FoundSimulation not foundInline
500Internal Server ErrorInternal server errorInline
\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
results[object]true
» idstring(uuid)
» namestring
» descriptionstring
» publicboolean
» sessionstring(uuid)simudyneSessionID cookie
» kindstring
\n

Example 200 response body

\n
{\n  \"results\": [\n    {\n      \"id\": \"0021674-3e3c-4ca7-87fc-e800c69feecd\",\n      \"name\": \"Game of Life\",\n      \"description\": \"string\",\n      \"public\": true,\n      \"session\": \"40dc68d-d798-46cb-bcfb-06c6a16a3492\",\n      \"kind\": \"pojo\"\n    }\n  ]\n}
\n
\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\": \"No usable value for ticks\\nDid not find value which can be converted into int\"\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\": \"SimulationRegistry: Could not find requested simulation default.\"\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

Example 500 response body

\n
{\n   \"message\": \"Exception during input. Cannot set float field `fillFactor` to non float value `\\\"three\\\"`.\"\n}
","headings":[{"value":"POST","depth":1},{"value":"Request","depth":2},{"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}],"frontmatter":{"title":"/api/simulations/batch","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.0/rest_api/batch/api_simulations_batch.md","versioned":true,"version":"2.0","kind":"rest_api","pagePath":"/rest_api/batch/api_simulations_batch","chronology":{"prev":{"name":"Batch Rest API","path":"/rest_api/batch"},"next":{"name":"/api/simulations/batch/{id}/config","path":"/rest_api/batch/api_simulations_batch_id_config"}},"lastUpdated":"2026-04-21T13:56:54.828Z"}}