Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Get simulation scenarios

Retrieve simulation scenarios that match the given filters.

Permissions

This endpoint may be impacted by the following permissions:

  • Only simulation scenarios that the authenticated user has Simulation:GetSimulationScenario permission for will be retrieved.
get/v1/{organization}/simulation/scenario/

Path parameters

organizationstring required

Query parameters

idstring[]

The IDs of the simulation scenarios to retrieve.

The IDs of the simulation scenarios to retrieve.

limitinteger

The maximum number of simulation scenarios to return.

The maximum number of simulation scenarios to return.

continuation_tokeninteger

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

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

is_deletedboolean nullable

Whether the simulation scenario is deleted.

Whether the simulation scenario is deleted.

creatorstring[]

The creators of the simulation scenarios. Each value must be of the format org_id,user_id.

The creators of the simulation scenarios. Each value must be of the format org_id,user_id.

tagstring[]

The tags of the simulation scenarios. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means to match any value. If value is empty, it matches against when the value is None.

The tags of the simulation scenarios. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means to match any value. If value is empty, it matches against when the value is None.

sort_bystring[]

The fields to sort the sets by. Supported fields are updated_at. 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 sets by. Supported fields are updated_at. 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 scenarios to fetch.

{"stackTrail":"components:schemas:src__app__endpoints__simulation__get_simulation_scenarios__Response:properties:continuation_token:anyOf","oasType":"schema","type":"unknown","title":"Continuation Token","description":"The continuation token to use to retrieve the next page of simulation scenarios.","nullable":true}