/api/simulations/batch/{id}

Last updated on 16th July 2024

GET

Given the id, returns the batch simulation object.

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'

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

Status Code 200

Name	Type	Required	Description
id	string(uuid)	true
progress	float	true	Progress of running batch process
metadata	object	true

Example 200 response body

{
  "id": "d7558ad9-3405-4a4c-972a-531a87fdcd27",
  "progress": 0.2,
  "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'"
}

Given the id, deletes the simulation.

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'

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

Status Code 404

Name	Type	Required
message	string	true

Example 404 response body

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