# Collate Test Suites API

**Canonical:** https://apis.io/apis/collate/collate-test-suites-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Test Suites API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Test Suites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

`TestSuite` is a set of test cases grouped together to capture data quality.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/dataQuality/testSuites` | List test suites |
| PUT | `/v1/dataQuality/testSuites` | Update logical test suite |
| POST | `/v1/dataQuality/testSuites` | Create a logical test suite |
| PUT | `/v1/dataQuality/testSuites/basic` | Create or Update Basic test suite |
| POST | `/v1/dataQuality/testSuites/basic` | Create a basic test suite |
| PUT | `/v1/dataQuality/testSuites/executable` | Create or Update Executable test suite |
| GET | `/v1/dataQuality/testSuites/name/{name}` | Get a test suite by name |
| DELETE | `/v1/dataQuality/testSuites/name/{name}` | Delete a logical test suite |
| GET | `/v1/dataQuality/testSuites/{id}` | Get a test suite by Id |
| DELETE | `/v1/dataQuality/testSuites/{id}` | Delete a logical test suite |
| PATCH | `/v1/dataQuality/testSuites/{id}` | Update a test suite |
| DELETE | `/v1/dataQuality/testSuites/async/{id}` | Delete a logical test suite asynchronously |
| DELETE | `/v1/dataQuality/testSuites/basic/name/{name}` | Delete a test suite |
| DELETE | `/v1/dataQuality/testSuites/basic/{id}` | Delete a test suite |
| DELETE | `/v1/dataQuality/testSuites/executable/name/{name}` | Delete a test suite |
| DELETE | `/v1/dataQuality/testSuites/executable/{id}` | Delete a test suite |
| GET | `/v1/dataQuality/testSuites/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/dataQuality/testSuites/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/dataQuality/testSuites/dataQualityReport` | Get Data Quality Report |
| POST | `/v1/dataQuality/testSuites/dataQualityReport/batch` | Run a batch of Data Quality Reports |
| GET | `/v1/dataQuality/testSuites/executionSummary` | Get the execution summary of test suites |
| GET | `/v1/dataQuality/testSuites/{id}/versions/{version}` | Get a version of the test suite |
| GET | `/v1/dataQuality/testSuites/history` | List all entity versions within a time range |
| GET | `/v1/dataQuality/testSuites/search/list` | List test suite using search service |
| GET | `/v1/dataQuality/testSuites/{id}/versions` | List test suite versions |
| PUT | `/v1/dataQuality/testSuites/restore` | Restore a soft deleted test suite |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-test-suites-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Test Suites

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-test-suites-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.