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 Definitions API

`Test Definition` is a definition of a type of test using which test cases are created that run against data to capture data quality.

OpenMetadata Test Definitions 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 Definitions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 13 operations across 8 paths, and defines 27 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.

13 operations 8 paths 27 schemas 3 DELETE6 GET1 PATCH1 POST2 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 Definitions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 13

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

Test Definitions 13

Test Definition is a definition of a type of test using which test cases are created that run against data to capture data quality.

GET
/v1/dataQuality/testDefinitions
List test definitions
listTestDefinitions 10 params → 200
PUT
/v1/dataQuality/testDefinitions
Update test definition
createOrUpdateTestDefinition body → 200
POST
/v1/dataQuality/testDefinitions
Create a test definition
createTestDefinition body → 200400
GET
/v1/dataQuality/testDefinitions/name/{name}
Get a test definition by name
getTestDefinitionByName 3 params → 200404
DELETE
/v1/dataQuality/testDefinitions/name/{name}
Delete a test definition
deleteTestDefinitionByName 3 params → 200404
GET
/v1/dataQuality/testDefinitions/{id}
Get a test definition by Id
get_4 4 params → 200404
DELETE
/v1/dataQuality/testDefinitions/{id}
Delete a test definition
deleteTestDefinition 3 params → 200404
PATCH
/v1/dataQuality/testDefinitions/{id}
Update a test definition
patchTestDefinition 1 param body → default
DELETE
/v1/dataQuality/testDefinitions/async/{id}
Asynchronously delete a test definition
deleteTestDefinitionAsync 3 params → 200404
GET
/v1/dataQuality/testDefinitions/{id}/versions/{version}
Get a version of the test definition
getSpecificTestDefinitionVersion 2 params → 200404
GET
/v1/dataQuality/testDefinitions/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_22 5 params → 200
GET
/v1/dataQuality/testDefinitions/{id}/versions
List test definition versions
listAllTestDefinitionVersion 1 param → 200
PUT
/v1/dataQuality/testDefinitions/restore
Restore a soft deleted test definition
restore_18 body → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are TestDefinition (42 properties), CreateTestDefinition (19 properties), TagLabel (13 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
TestCaseParameterValidationRule
object
2 properties
JsonPatch
object
ChangeDescription
object
5 properties
TestDefinition
object
42 properties 2 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
TestCaseParameter
object
7 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
TestDefinitionList
object
5 properties 1 required
EntityReference
object
9 properties 2 required
CreateTestDefinition
object
19 properties 3 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-test-definitions-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 Definitions 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.