How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Test Cases API

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

OpenMetadata Test Cases API is one of 89 APIs that OpenMetadata publishes on the 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 authentication docs.

This API exposes 26 operations across 19 paths, and defines 48 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

26 operations 19 paths 48 schemas 5 DELETE10 GET1 PATCH2 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Test Cases API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 26

Across 19 paths, the API surfaces 26 operations — 5 DELETE, 10 GET, 1 PATCH, 2 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Test Cases 26

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

GET
/v1/dataQuality/testCases/{id}/failedRowsSample
Get failed rows sample data
getFailedRowsSample 1 param → 200
PUT
/v1/dataQuality/testCases/{id}/failedRowsSample
Add failed rows sample data
addFailedRowsSample 2 params body → 200400
DELETE
/v1/dataQuality/testCases/{id}/failedRowsSample
Delete failed rows sample data
deleteFailedRowsSample 1 param → 200404
PUT
/v1/dataQuality/testCases/{id}/inspectionQuery
Add inspection query data
addInspectionQuery 1 param body → 200
PUT
/v1/dataQuality/testCases/logicalTestCases/bulk
Add test cases to a logical test suite
addManyTestCasesToBundleTestSuite body → 200
PUT
/v1/dataQuality/testCases/logicalTestCases
Add test cases to a logical test suite
addTestCasesToBundleTestSuite body → 200
GET
/v1/dataQuality/testCases
List test cases
listTestCases 13 params → 200
PUT
/v1/dataQuality/testCases
Update test case
createOrUpdateTest body → 200
POST
/v1/dataQuality/testCases
Create a test case
createTestCase body → 200400
POST
/v1/dataQuality/testCases/createMany
Create multiple test cases at once
createManyTestCase body → 200400413
GET
/v1/dataQuality/testCases/name/{fqn}
Get a test case by fully qualified name
getTestCaseByName 4 params → 200404
DELETE
/v1/dataQuality/testCases/name/{fqn}
Delete a test case by fully qualified name
deleteTestCaseByName 3 params → 200404
GET
/v1/dataQuality/testCases/{id}
Get a test case by Id
get_3 4 params → 200404
DELETE
/v1/dataQuality/testCases/{id}
Delete a test case by Id
deleteTestCase 3 params → 200404
PATCH
/v1/dataQuality/testCases/{id}
Update a test case
patchTest 1 param body → default
DELETE
/v1/dataQuality/testCases/async/{id}
Asynchronously delete a test case by Id
deleteTestCaseAsync 3 params → 200404
DELETE
/v1/dataQuality/testCases/logicalTestCases/{testSuiteId}/{id}
Delete a logical test case by Id from a test suite
deleteLogicalTestCase 2 params → 200404
GET
/v1/dataQuality/testCases/name/{name}/export
Export test cases in CSV format
exportTestCases 1 param → 200
GET
/v1/dataQuality/testCases/name/{name}/exportAsync
Export test cases in CSV format asynchronously
exportTestCasesAsync 1 param → 200
GET
/v1/dataQuality/testCases/{id}/versions/{version}
Get a version of the test case
getSpecificTestCaseVersion 2 params → 200404
PUT
/v1/dataQuality/testCases/name/{name}/import
Import test cases from CSV
importTestCases 3 params body → 200
PUT
/v1/dataQuality/testCases/name/{name}/importAsync
Import test cases from CSV asynchronously
importTestCasesAsync 3 params body → 200
GET
/v1/dataQuality/testCases/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_21 5 params → 200
GET
/v1/dataQuality/testCases/search/list
List test cases using search service
listTestCasesFromSearchService 28 params → 200
GET
/v1/dataQuality/testCases/{id}/versions
List test case versions
listAllTestCaseVersion 1 param → 200
PUT
/v1/dataQuality/testCases/restore
Restore a soft deleted test case
restore_17 body → 200

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are TestCase (47 properties), TestSuite (44 properties), CreateTestCase (17 properties), Response (17 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
StatusType
object
3 properties
DimensionValue
object
2 properties 2 required
TestSuiteConnection
object
1 property
ChangeSummaryMap
object
TestSuite
object
44 properties 1 required
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
Response
object
17 properties
Link
object
7 properties
LifeCycle
object
3 properties
BundleSuiteBulkAddRequest
object
3 properties 3 required
TestCaseDimensionResult
object
14 properties 6 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultSummary
object
3 properties
ResultList
object
5 properties 1 required
ColumnTestSummaryDefinition
object
6 properties
CreateTestCase
object
17 properties 3 required
TestCaseList
object
5 properties 1 required
TableData
object
2 properties
Paging
object
5 properties 1 required
UriBuilder
object
TestConnectionResult
object
3 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
NewCookie
object
11 properties
MediaType
object
5 properties
TestSummary
object
6 properties
UsageStats
object
2 properties 1 required
Style
object
3 properties
TestCaseResult
object
17 properties 1 required
Votes
object
4 properties
TestResultValue
object
3 properties
CsvImportResult
object
7 properties
TestCaseParameterValue
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
EntityTag
object
2 properties
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
CreateLogicalTestCases
object
2 properties 2 required
TestConnectionStepResult
object
5 properties 3 required
EntityReference
object
9 properties 2 required
TestCase
object
47 properties 4 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-test-cases-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Test Cases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.