/api/simulations/interactive/{id}/ticks
Last updated on 16th July 2024
GET
Given the id, returns the array of ticks, time-steps within the simulation.
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/interactive/{id}/ticks \
-H 'Accept: application/json'Response
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response completed sucessfully | Inline |
| 404 | Not Found | Simulation not found | Inline |
Response Schema
Status Code 200
| Name | Type | Required |
|---|---|---|
| ticks | [object] | true |
| » time | string(date-time) | |
| » tick | integer | |
| » data | object | |
| »» time | object | true |
| »»» start | string(date-time) | true |
| »»» end | string(date-time) | true |
| »»» timeStep | integer | true |
| »»» ticks | integer | true |
| »»» macroStep | integer | true |
Example 200 response body
{
"ticks": [
{
"time": "2018-01-01T00:00Z",
"tick": 0,
"data": {
"distributed": false,
"gridSize": 20,
"system": {
"fillFactor": 0.25
},
"time": {
"start": "2018-01-01T00:00Z",
"end": "2023-01-01T00:00Z",
"timeStep": 1,
"timeUnit": "Months",
"ticks": 60,
"macroStep": 25
}
},
{ ... }
]
}Status Code 404
| Name | Type | Required |
|---|---|---|
| message | string | true |
Example 404 response body
{
"message": "Could not find simulation '5af75d69-1926-4ef2-a56f-07ad5f85673b'"
}