latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Get simulation unit tests

Retrieve the simulation unit tests that match the given filters.

Permissions

This endpoint may be impacted by the following permissions:

  • Only simulation unit tests that the authenticated user has Simulation:GetSimulationUnitTest permission for will be retrieved.
get/v1/{organization}/simulation/unit_test/

Path parameters

organizationstring required

Query parameters

idstring[]

The IDs of the simulation unit tests to retrieve.

The IDs of the simulation unit tests to retrieve.

limitinteger

The maximum number of simulation unit tests to return.

The maximum number of simulation unit tests to return.

continuation_tokeninteger

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

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

is_deletedboolean nullable

Whether the simulation unit test is deleted.

Whether the simulation unit test is deleted.

service_idstring[]

The IDs of the services that the simulation unit tests run on.

The IDs of the services that the simulation unit tests run on.

persona_idstring[]

The IDs of the personas that the simulation unit tests use.

The IDs of the personas that the simulation unit tests use.

scenario_idstring[]

The IDs of the scenarios that the simulation unit tests use.

The IDs of the scenarios that the simulation unit tests use.

metric_idstring[]

The IDs of the metrics that the simulation unit tests use.

The IDs of the metrics that the simulation unit tests use.

creatorstring[]

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

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

tagstring[]

The tags of the simulation unit tests. 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 unit tests. 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.

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 unit tests to retrieve.

continuation_tokeninteger nullable required

The continuation token to use to retrieve the next page of simulation unit tests.