/api/simulations/scenario/{id}
Last updated on 16th July 2024
GET
Returns progress of current scenario run.
Request
Example request body
curl -X GET \
http://localhost:8080/api/simulations/scenario/eb8d46a9-878e-4556-a3f3-19ac9b7e858dResponse
An double value between 0 and 1 where 0 is a scenario that hasn't begun and 1 is a scenario that whose run has completed.
Response Schema
Status Code 200
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | true | |
| progress | float | true | Progress of running scenario process |
| timestamp | Long | true | When the batch run started |
| metadata | object | true | |
| dataExportPath | String | true | Where the data is exported |
Example 200 response body
{
"id":"9bdf5359-cddf-45e9-a93a-7b92ab08c700",
"progress":1.0,
"timestamp":1549622408454,
"metadata":{
"kind": "pojo",
"schema": {...}
},
"dataExportPath":"/tmp/scenario/runs"
}Status Code **404**
| Name | Type | Required |
|---|---|---|
| message | string | true |
Example 404 response body
{
"message": "Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'"
}