GET /simulations/{simulationKey}/runs/{runIndex}/systems

Retrieves the systems that were used in a specific simulation run. Systems define how to import data into the simulation.

Path Parameters

The unique key of the simulation.

The index of the simulation run. Must be an integer greater than or equal to 1.

Request

Maximum number of systems to return. Must be an integer between 1 and 100. Defaults to 10.

Number of systems to skip. Must be an integer greater than or equal to 0. Defaults to 0.

Success

Responds with a 200 OK and an array of systems.

The unique key of the system.

The format of the data provided by this system. Can be json orsql.

Configuration for importing data from this system. Contains a command field specifying the command to execute, and optional before andafter fields for setup and teardown.

Failure

Responds with a 404 Not Found if the simulation run does not exist.

Example

Request to get systems from a simulation run:

GET /simulations/my-simulation/runs/1/systems

Response:

[
  {
    "key": "postgres",
    "format": {
      "type": "sql",
      "table": "users"
    },
    "import": {
      "command": "psql -h localhost -U user -d mydb",
      "before": "CREATE TABLE IF NOT EXISTS users (id INT, name TEXT);",
      "after": "DROP TABLE users;"
    }
  }
]