# Collate Test Cases API

**Canonical:** https://apis.io/apis/collate/collate-test-cases-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 Cases 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 Cases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Test case is a test definition to capture data quality tests against tables, columns, and other data assets.

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/dataQuality/testCases/{id}/failedRowsSample` | Get failed rows sample data |
| PUT | `/v1/dataQuality/testCases/{id}/failedRowsSample` | Add failed rows sample data |
| DELETE | `/v1/dataQuality/testCases/{id}/failedRowsSample` | Delete failed rows sample data |
| PUT | `/v1/dataQuality/testCases/{id}/inspectionQuery` | Add inspection query data |
| PUT | `/v1/dataQuality/testCases/logicalTestCases/bulk` | Add test cases to a logical test suite |
| PUT | `/v1/dataQuality/testCases/logicalTestCases` | Add test cases to a logical test suite |
| GET | `/v1/dataQuality/testCases` | List test cases |
| PUT | `/v1/dataQuality/testCases` | Update test case |
| POST | `/v1/dataQuality/testCases` | Create a test case |
| POST | `/v1/dataQuality/testCases/createMany` | Create multiple test cases at once |
| GET | `/v1/dataQuality/testCases/name/{fqn}` | Get a test case by fully qualified name |
| DELETE | `/v1/dataQuality/testCases/name/{fqn}` | Delete a test case by fully qualified name |
| GET | `/v1/dataQuality/testCases/{id}` | Get a test case by Id |
| DELETE | `/v1/dataQuality/testCases/{id}` | Delete a test case by Id |
| PATCH | `/v1/dataQuality/testCases/{id}` | Update a test case |
| DELETE | `/v1/dataQuality/testCases/async/{id}` | Asynchronously delete a test case by Id |
| DELETE | `/v1/dataQuality/testCases/logicalTestCases/{testSuiteId}/{id}` | Delete a logical test case by Id from a test suite |
| GET | `/v1/dataQuality/testCases/name/{name}/export` | Export test cases in CSV format |
| GET | `/v1/dataQuality/testCases/name/{name}/exportAsync` | Export test cases in CSV format asynchronously |
| GET | `/v1/dataQuality/testCases/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/dataQuality/testCases/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/dataQuality/testCases/{id}/versions/{version}` | Get a version of the test case |
| PUT | `/v1/dataQuality/testCases/name/{name}/import` | Import test cases from CSV |
| PUT | `/v1/dataQuality/testCases/name/{name}/importAsync` | Import test cases from CSV asynchronously |
| GET | `/v1/dataQuality/testCases/history` | List all entity versions within a time range |
| GET | `/v1/dataQuality/testCases/search/list` | List test cases using search service |
| GET | `/v1/dataQuality/testCases/{id}/versions` | List test case versions |
| PUT | `/v1/dataQuality/testCases/restore` | Restore a soft deleted test case |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-test-cases-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 Cases

---

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