latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Search simulation scenarios

Search for simulation scenarios that match the given filters and contain the given query in its name. Only the top 50 results will be returned. The results will be sorted by the relevance of the search query.

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/search

Path parameters

organizationstring required

Query parameters

querystring required

The query to search for. Any simulation scenarios containing the terms in its name would be returned.

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 the value does not matter. 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 the value does not matter. If value is empty, it matches against when the value is None.

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.