Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Get simulation scenario versions

Retrieve the versions of a simulation scenario.

Permissions

This endpoint requires the following permissions:

  • Simulation:GetSimulationScenario for the simulation scenario.
get/v1/{organization}/simulation/scenario/{simulation_scenario_id}/version/

Path parameters

organizationstring required
simulation_scenario_idstring required

The ID of the simulation scenario to get versions for.

The ID of the simulation scenario to get versions for.

Query parameters

versionstring nullable

The versions of the simulation scenario to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.

Example:1

The versions of the simulation scenario to retrieve. One can specify an exact version to retrieve, which is either the version number or latest, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -, and every version within the range would be retrieved.

limitinteger

The maximum number of simulation scenario versions to return.

The maximum number of simulation scenario versions to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of simulation scenario version.

The continuation token from the previous request used to retrieve the next page of simulation scenario version.

sort_bystring[]

The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more simulation scenario versions to fetch.

{"stackTrail":"components:schemas:src__app__endpoints__simulation__get_simulation_scenario_versions__Response:properties:continuation_token:anyOf","oasType":"schema","type":"unknown","title":"Continuation Token","description":"A token to supply to the next request to retreive the next page of simulation scenario versions.","nullable":true}