/api/simulations/batch/{id}

Last updated on 12th October 2022

GET

Given the id, returns the batch simulation object.

Request

Parameters

Name Located in Description Required Schema
id path ID of simulation Yes string

Example request

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

Response

Status Meaning Description Schema
200 OK Request was completed successfully Inline
404 Not Found Simulation not found Inline

Response Schema

Status Code 200

Name Type Required Description
id string(uuid) true
progress float true Progress of running batch process
ticks Integer true Number of ticks per run
runs Integer true Number of runs
timestamp Long true When the batch run started
metadata object true
dataExportPath String Where the data is exported

Example 200 response body

{
    "id":"ae0d07c4-2942-4ea6-9fc1-a93f35b10ff4",
    "progress":1.0,
    "ticks":100,
    "runs":10,
    "timestamp":1549622693467,
    "metadata":{
        "kind":"pojo",
        "schema":{...}
    }
}

Status Code 404

Name Type Required
message string true

Example 404 response body

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

DELETE

Given the id, deletes the simulation.

Request

Parameters

Name Located in Description Required Schema
id path id of simulation Yes string

Example request

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

Response

Status Meaning Description Schema
204 No Content Request was completed successfully None
404 Not Found Simulation not found Inline

Response Schema


Status Code 404

Name Type Required
message string true

Example 404 response body

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