Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Get simulation unit test set runs

Retrieves simulation unit test set runs.

This endpoint may be impacted by the following permissions:

  • Only the runs that the authenticated user has the Simulation:GetSimulationUnitTestSetRun permission for will be returned.
  • The unit_test_run_specs and unit_test_run_results fields are only populated if the authenticated user has the Simulation:GetSimulationUnitTestSet permission.
  • The fields scenario_version_info, persona_version_info, metrics_to_evaluate in unit_test_run_specs and the field metric_evaluation_results in unit_test_run_results are only populated if the authenticated user has the Simulation:GetSimulationUnitTest permission.
get/v1/{organization}/simulation/unit_test_set_run/

Path parameters

organizationstring required

Query parameters

idstring[]

The ID of the simulation unit test set run to retrieve.

The ID of the simulation unit test set run to retrieve.

limitinteger

The maximum number of simulation unit test set runs to return.

The maximum number of simulation unit test set runs to return.

continuation_tokeninteger

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

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

creatorstring[]

The creators of the simulation unit test set runs to retrieve. Each value must be of the format org_id,user_id.

The creators of the simulation unit test set runs to retrieve. Each value must be of the format org_id,user_id.

sort_bystring[]

The fields to sort the sets by. Supported fields are created_at.

The fields to sort the sets by. Supported fields are created_at.

simulation_unit_test_set_idstring[]

The IDs of the simulation unit test sets that the simulation unit test set runs belong to.

The IDs of the simulation unit test sets that the simulation unit test set runs belong to.

is_completedboolean nullable

Whether the simulation unit test set run is completed.

Whether the simulation unit test set run is completed.

failed_metricsboolean nullable

Whether the simulation unit test set run has failed due to failing metrics. Note that this field could be True even if the run is still ongoing -- it simply means some unit test runs have failed.

Whether the simulation unit test set run has failed due to failing metrics. Note that this field could be True even if the run is still ongoing -- it simply means some unit test runs have failed.

erroredboolean nullable

Whether the simulation unit test set run has encountered an error.

Whether the simulation unit test set run has encountered an error.

created_afterstring date-time nullable

Filter for simulation unit test set runs created at or after this time (inclusive).

Filter for simulation unit test set runs created at or after this time (inclusive).

created_beforestring date-time nullable

Filter for simulation unit test set runs created at or before this time (inclusive).

Filter for simulation unit test set runs created at or before this time (inclusive).

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.

simulation_unit_test_set_runsSimulationUnitTestSetRunInstance[] required— unresolved $ref

The retrieved simulation unit test set runs.

has_moreboolean required

Whether there are more simulation unit test set runs to retrieve.

continuation_tokeninteger nullable required

The continuation token to use to retrieve the next page of simulation unit test set runs.