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

Retrieves the entities that were used in a specific simulation run.

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 entities to return. Must be an integer between 1 and 100. Defaults to 10.

Number of entities 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 entities.

The unique key of the entity.

The rate at which entity instances are generated. Uses a duration expression like 1/day or 100/second.

The output format for the entity data. Can be json or sql.

Reference to a system that provides the entity data. Contains a type field indicating which system to use.

The schema definition for the entity, similar to JSON Schema format.

Failure

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

Example

Request to get entities from a simulation run:

GET /simulations/my-simulation/runs/1/entities?limit=2

Response:

[
  {
    "key": "users",
    "rate": "10/second",
    "schema": {
      "type": "object",
      "properties": {
        "id": { "type": "integer" },
        "name": { "type": "string" }
      }
    }
  },
  {
    "key": "posts",
    "rate": "50/minute",
    "schema": {
      "type": "object",
      "properties": {
        "id": { "type": "integer" },
        "title": { "type": "string" },
        "userId": { "type": "integer" }
      }
    }
  }
]