---
title: "Search simulation unit test sets"
method: GET
path: "/v1/{organization}/simulation/unit_test_set/search/"
tags: ["Simulation"]
---

# Search simulation unit test sets

`GET /v1/{organization}/simulation/unit_test_set/search/`

Search for simulation unit test sets that match the given filters and whose name or description contains the specified query.

#### Permissions
This endpoint may be impacted by the following permissions:
* Only simulation unit test sets that the authenticated user has `Simulation:GetSimulationUnitTestSet` permission for will be retrieved.

## Path parameters

- `organization` string, required

## Query parameters

- `query` string, required
- `creator` string[] — The creators of the simulation unit test sets. Each value must be of the format `org_id,user_id`.
- `tag` string[] — The tags of the simulation unit test sets. 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`.
- `unit_test_id` string[] — The IDs of the unit tests that are part of the simulation unit test sets.

## Headers

- `x-mongo-cluster-name` string, 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.
- `Sec-WebSocket-Protocol` string[]

## Response `200`

Succeeded.

- SrcAppEndpointsSimulationSearchSimulationUnitTestSetResponse
  - `simulation_unit_test_sets` SimulationUnitTestSet[], required — The retrieved simulation unit test sets.
    - `_id` string, required — The ID of the document.
    - `org_id` string, required — The ID of the organization.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string, required — The name of the simulation unit test set.
    - `description` string, nullable, required — The description of the simulation unit test set.
    - `unit_test_runs` UnitTestRunDescriptorOutput[], required — The unit test runs that are part of this set.
      - `unit_test_id` string, required
      - `run_count` integer, required
    - `last_triggered_run_id` string, nullable, required — The last unit test set run that was triggered.
    - `is_deleted` boolean, required — Whether the unit test set has been deleted.
    - `tags` Tag[], required — The tags of the simulation unit test set.
      - `key` string, required
      - `value` string, nullable, required
    - `creator` AmigoLibMongoCollectionsSimulationUnitTestSetSimulationUnitTestSetUserInfo, required
      - `org_id` string, required
      - `user_id` string, required
    - `updated_by` AmigoLibMongoCollectionsSimulationUnitTestSetSimulationUnitTestSetUserInfo, required
      - `org_id` string, required
      - `user_id` string, required

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — Specified organization is not found.
- `422` — Invalid request path parameter or request query parameter failed validation.
- `429` — The user has exceeded the rate limit of 50 requests per minute for this endpoint.
- `503` — The service is going through temporary maintenance.

---

[API](https://skmtc.net/amigo/apis/amigo-api.md) · [All operations](https://skmtc.net/amigo/apis/amigo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/amigo/amigo-api/revisions/f0f28319e448/schema)
