Simulation Runs

Every time a simulation routine executes, a simulation run object is created. This object ensures that each execution of a routine is documented and traceable. Each run has an associated simulation data resource, which stores the inputs and outputs of a simulation run, capturing the values set into and read from the simulator model to ensure the traceability and integrity of the simulation data.

Simulation runs provide a historical record of the simulations performed, allowing users to analyze and compare different runs, track changes over time, and make informed decisions based on the simulation results.

When simulation run load balancing is enabled and the routine is not assigned to any particular simulator integration, the run initiates with status queued and any active simulator integration can claim it automatically. Without load balancing, the run initiates with status ready and is tied to the simulator integration specified on the routine.

Limitations:

  • A retention policy is in place for simulation runs, allowing up to 100000 entries. When this limit is reached, the oldest runs are deleted to make room for new ones.
  • The total size of all inputs for a simulation run can be a maximum of 50.00 KB.
  • The total size of simulation run data sent by the connector can be a maximum of 100.00 KB.

Run Simulation

Request to run a simulator routine asynchronously.

The total size of the request body can be a maximum of 50.00 KB.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of SimulationRunCommandByRoutine (object) or SimulationRunCommandByRoutineRevision (object) (Items)

A list with a single item

Responses
201

Successful Response

400

Bad Request

403

Forbidden

413

Request Entity Too Large

500

Internal Server Error

post/simulators/run
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Filter Simulation Runs

Retrieves a list of simulation runs that match the given criteria.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
object (ListSimulationRunsFilters)
limit
integer (Limit) [ 1 .. 1000 ]
Default: 1000
cursor
string (Cursor)

Cursor for pagination

Array of SortByCreatedTime (object) or SortBySimulationTime (object) (Sort)

Only supports sorting by one property at a time

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/runs/list
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 1000,
  • "cursor": "string",
  • "sort": [
    ]
}
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Retrieve Simulation

Retrieve a simulation run by ID.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects (Items)

A list with a single item

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/runs/byids
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Retrieve Simulation Data

Retrieve data associated with a simulation run by ID.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects (Items)

A list with a single item

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/runs/data/list
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}
➔ Next to Simulator Logs