Test Case¶

Specific test instances applied to data assets with parameters and results

Overview¶

The TestCase entity represents a specific instance of a test applied to a table or column. Test cases are created from test definitions and include configured parameters, execution results, and historical test run data.

Relationship Diagram¶

graph TD
    %% Main entity
    TC[TestCase<br/>customers_row_count_check]

    %% Based on definition
    TD[TestDefinition<br/>tableRowCountToBeBetween] -->|template for| TC

    %% Parameter values
    TC -->|configured with| PARAM1[ParameterValue<br/>minValue: 10000]
    TC -->|configured with| PARAM2[ParameterValue<br/>maxValue: 50000]

    %% Parent test suite
    TS[TestSuite<br/>customers.testSuite] -->|contains| TC

    %% Tests entity
    TC -.->|tests| TBL[Table<br/>customers]

    %% Database hierarchy context
    SVC[DatabaseService<br/>postgres_prod] -->|contains| DB[Database<br/>ecommerce]
    DB -->|contains| SCH[Schema<br/>public]
    SCH -->|contains| TBL
    TBL -->|has| COL1[Column<br/>customer_id]
    TBL -->|has| COL2[Column<br/>email]

    %% Test results
    TC -->|produces| RES1[TestResult<br/>Success<br/>32,450 rows]
    TC -->|produces| RES2[TestResult<br/>Success<br/>31,890 rows]
    TC -->|produces| RES3[TestResult<br/>Failed<br/>8,234 rows]

    %% Result history timeline
    RES3 -.->|older than| RES2
    RES2 -.->|older than| RES1

    %% Governance
    OWNER[User<br/>Jane Doe] -.->|owns| TC

    %% Alerts and actions
    RES3 -.->|triggers| ALERT[Alert<br/>Row count below threshold]
    ALERT -.->|notifies| OWNER

    %% Other test cases
    TC2[TestCase<br/>email_unique_check] -.->|tests| COL2
    TD2[TestDefinition<br/>columnValuesToBeUnique] -->|template for| TC2
    TS -->|contains| TC2
    TC2 -->|produces| RES4[TestResult<br/>Success<br/>All unique]

    TC3[TestCase<br/>created_at_not_null] -.->|tests| COL3[Column<br/>created_at]
    TD3[TestDefinition<br/>columnValuesToBeNotNull] -->|template for| TC3
    TS -->|contains| TC3

    %% Execution scheduling
    SCHEDULE[Schedule<br/>Daily 2 AM] -.->|executes| TS
    SCHEDULE -.->|triggers| TC

    %% Status indicators
    STATUS[Status<br/>Active] -.->|state| TC

    %% Styling
    classDef definition fill:#8B5CF6,stroke:#7C3AED,color:#fff
    classDef testcase fill:#DC2626,stroke:#B91C1C,color:#fff
    classDef suite fill:#EF4444,stroke:#DC2626,color:#fff
    classDef parameter fill:#A78BFA,stroke:#8B5CF6,color:#fff
    classDef data fill:#2563EB,stroke:#1E40AF,color:#fff
    classDef result fill:#F59E0B,stroke:#D97706,color:#fff
    classDef governance fill:#059669,stroke:#047857,color:#fff
    classDef alert fill:#DC2626,stroke:#B91C1C,color:#fff

    class TD,TD2,TD3 definition
    class TC,TC2,TC3 testcase
    class TS suite
    class PARAM1,PARAM2 parameter
    class SVC,DB,SCH,TBL,COL1,COL2,COL3 data
    class RES1,RES2,RES3,RES4 result
    class OWNER,STATUS governance
    class ALERT,SCHEDULE alert

Schema Specifications¶

View the complete TestCase schema in your preferred format:

JSON SchemaRDFJSON-LD

Complete JSON Schema Definition

{
  "$id": "https://open-metadata.org/schema/entity/data/testCase.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TestCase",
  "description": "A `TestCase` is a specific instance of a test applied to a table or column with configured parameters.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.TestCase",

  "definitions": {
    "testCaseStatus": {
      "description": "Status of the test case",
      "type": "string",
      "enum": ["Success", "Failed", "Aborted", "Queued"]
    },
    "testCaseResult": {
      "type": "object",
      "properties": {
        "timestamp": {
          "description": "Test execution timestamp",
          "type": "integer",
          "format": "int64"
        },
        "testCaseStatus": {
          "$ref": "#/definitions/testCaseStatus"
        },
        "result": {
          "description": "Test result value",
          "type": "string"
        },
        "sampleData": {
          "description": "Sample failing data",
          "type": "string"
        },
        "testResultValue": {
          "description": "Array of result values",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {"type": "string"},
              "value": {"type": "string"}
            }
          }
        },
        "passedRows": {
          "type": "integer"
        },
        "failedRows": {
          "type": "integer"
        }
      },
      "required": ["timestamp", "testCaseStatus"]
    },
    "testCaseParameterValue": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": ["name"]
    }
  },

  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Test case name",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "Fully qualified name",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Display name",
      "type": "string"
    },
    "description": {
      "description": "Markdown description",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "testDefinition": {
      "description": "Test definition reference",
      "$ref": "../../type/entityReference.json"
    },
    "entityLink": {
      "description": "Link to table or column",
      "type": "string",
      "format": "uri"
    },
    "entityFQN": {
      "description": "FQN of the entity being tested",
      "type": "string"
    },
    "testSuite": {
      "description": "Parent test suite",
      "$ref": "../../type/entityReference.json"
    },
    "parameterValues": {
      "description": "Parameter values for this test",
      "type": "array",
      "items": {
        "$ref": "#/definitions/testCaseParameterValue"
      }
    },
    "testCaseResult": {
      "description": "Latest test result",
      "$ref": "#/definitions/testCaseResult"
    },
    "testCaseResults": {
      "description": "Historical test results",
      "type": "array",
      "items": {
        "$ref": "#/definitions/testCaseResult"
      }
    },
    "owner": {
      "description": "Owner (user or team)",
      "$ref": "../../type/entityReference.json"
    },
    "version": {
      "description": "Metadata version",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    }
  },

  "required": ["id", "name", "testDefinition", "entityLink"]
}

View Full JSON Schema →

RDF/OWL Ontology Definition

@prefix om: <https://open-metadata.org/schema/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2001/XMLSchema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# TestCase Class Definition
om:TestCase a owl:Class ;
    rdfs:subClassOf om:DataQualityAsset ;
    rdfs:label "TestCase" ;
    rdfs:comment "A specific test instance applied to a table or column" ;
    om:hierarchyLevel 2 .

# Properties
om:testCaseName a owl:DatatypeProperty ;
    rdfs:domain om:TestCase ;
    rdfs:range xsd:string ;
    rdfs:label "name" ;
    rdfs:comment "Name of the test case" .

om:entityLink a owl:DatatypeProperty ;
    rdfs:domain om:TestCase ;
    rdfs:range xsd:anyURI ;
    rdfs:label "entityLink" ;
    rdfs:comment "Link to the entity being tested" .

om:basedOnDefinition a owl:ObjectProperty ;
    rdfs:domain om:TestCase ;
    rdfs:range om:TestDefinition ;
    rdfs:label "testDefinition" ;
    rdfs:comment "Test definition this case is based on" .

om:belongsToTestSuite a owl:ObjectProperty ;
    rdfs:domain om:TestCase ;
    rdfs:range om:TestSuite ;
    rdfs:label "testSuite" ;
    rdfs:comment "Parent test suite" .

om:hasParameterValue a owl:ObjectProperty ;
    rdfs:domain om:TestCase ;
    rdfs:range om:ParameterValue ;
    rdfs:label "parameterValues" ;
    rdfs:comment "Configured parameter values" .

om:hasTestResult a owl:ObjectProperty ;
    rdfs:domain om:TestCase ;
    rdfs:range om:TestCaseResult ;
    rdfs:label "testCaseResult" ;
    rdfs:comment "Latest test execution result" .

om:testStatus a owl:DatatypeProperty ;
    rdfs:domain om:TestCaseResult ;
    rdfs:range om:TestCaseStatus ;
    rdfs:label "testCaseStatus" ;
    rdfs:comment "Status of test execution" .

# TestCaseStatus Enumeration
om:TestCaseStatus a owl:Class ;
    owl:oneOf (
        om:SuccessStatus
        om:FailedStatus
        om:AbortedStatus
        om:QueuedStatus
    ) .

# Example Instance
ex:customersRowCountTest a om:TestCase ;
    om:testCaseName "customers_row_count_check" ;
    om:displayName "Customers Table Row Count Validation" ;
    om:basedOnDefinition ex:tableRowCountToBeBetween ;
    om:entityLink "table://postgres_prod.ecommerce.public.customers" ;
    om:belongsToTestSuite ex:customersTestSuite ;
    om:hasParameterValue ex:minValue10000 ;
    om:hasParameterValue ex:maxValue50000 ;
    om:hasTestResult ex:latestResult .

View Full RDF Ontology →

JSON-LD Context and Example

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/",
    "om": "https://open-metadata.org/schema/",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "TestCase": "om:TestCase",
    "name": {
      "@id": "om:testCaseName",
      "@type": "xsd:string"
    },
    "fullyQualifiedName": {
      "@id": "om:fullyQualifiedName",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "om:displayName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "om:description",
      "@type": "xsd:string"
    },
    "testDefinition": {
      "@id": "om:basedOnDefinition",
      "@type": "@id"
    },
    "entityLink": {
      "@id": "om:entityLink",
      "@type": "xsd:anyURI"
    },
    "testSuite": {
      "@id": "om:belongsToTestSuite",
      "@type": "@id"
    },
    "parameterValues": {
      "@id": "om:hasParameterValue",
      "@type": "@id",
      "@container": "@list"
    },
    "testCaseResult": {
      "@id": "om:hasTestResult",
      "@type": "@id"
    },
    "owner": {
      "@id": "om:ownedBy",
      "@type": "@id"
    }
  }
}

Example JSON-LD Instance:

{
  "@context": "https://open-metadata.org/context/testCase.jsonld",
  "@type": "TestCase",
  "@id": "https://example.com/testCases/customers_row_count",

  "name": "customers_row_count_check",
  "fullyQualifiedName": "postgres_prod.ecommerce.public.customers.testSuite.customers_row_count_check",
  "displayName": "Customers Table Row Count Validation",
  "description": "Ensures the customers table has between 10K-50K rows",

  "testDefinition": {
    "@id": "https://open-metadata.org/testDefinitions/tableRowCountToBeBetween",
    "@type": "TestDefinition",
    "name": "tableRowCountToBeBetween"
  },

  "entityLink": "table://postgres_prod.ecommerce.public.customers",
  "entityFQN": "postgres_prod.ecommerce.public.customers",

  "testSuite": {
    "@id": "https://example.com/testSuites/customers_suite",
    "@type": "TestSuite",
    "name": "customers.testSuite"
  },

  "parameterValues": [
    {
      "name": "minValue",
      "value": "10000"
    },
    {
      "name": "maxValue",
      "value": "50000"
    }
  ],

  "testCaseResult": {
    "timestamp": 1704240000000,
    "testCaseStatus": "Success",
    "result": "Row count: 32450",
    "testResultValue": [
      {
        "name": "actualRowCount",
        "value": "32450"
      }
    ]
  }
}

View Full JSON-LD Context →

Use Cases¶

Validate data quality on specific tables and columns
Monitor data quality trends over time
Alert on test failures
Track data quality SLAs
Implement data contracts with quality gates
Profile data quality metrics
Compare test results across environments
Schedule automated test execution

JSON Schema Specification¶

Core Properties¶

`id` (uuid)¶

Type: string (UUID format) Required: Yes (system-generated) Description: Unique identifier for this test case

{
  "id": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c"
}

`name` (entityName)¶

Type: string Required: Yes Pattern: ^[^.]*$ (no dots allowed) Description: Name of the test case

{
  "name": "customers_row_count_check"
}

`fullyQualifiedName` (fullyQualifiedEntityName)¶

Type: string Required: Yes (system-generated) Description: Fully qualified name including test suite

{
  "fullyQualifiedName": "postgres_prod.ecommerce.public.customers.testSuite.customers_row_count_check"
}

`displayName`¶

Type: string Required: No Description: Human-readable display name

{
  "displayName": "Customers Table Row Count Validation"
}

`description` (markdown)¶

Type: string (Markdown format) Required: No Description: Description of what this test validates

{
  "description": "# Row Count Validation\n\nEnsures the customers table maintains between 10,000 and 50,000 rows.\n\n## Alert Conditions\n- Below 10K: Data pipeline issue\n- Above 50K: Unexpected data growth"
}

Test Configuration Properties¶

`testDefinition` (EntityReference)¶

Type: object Required: Yes Description: Reference to the test definition this case is based on

{
  "testDefinition": {
    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "type": "testDefinition",
    "name": "tableRowCountToBeBetween",
    "fullyQualifiedName": "tableRowCountToBeBetween"
  }
}

`entityLink` (uri)¶

Type: string (URI format) Required: Yes Description: Link to the table or column being tested

Format: <entityType>://<fullyQualifiedName>

{
  "entityLink": "table://postgres_prod.ecommerce.public.customers"
}

Column Example:

{
  "entityLink": "column://postgres_prod.ecommerce.public.customers.email"
}

`entityFQN` (string)¶

Type: string Required: No Description: Fully qualified name of the entity being tested

{
  "entityFQN": "postgres_prod.ecommerce.public.customers"
}

`testSuite` (EntityReference)¶

Type: object Required: No Description: Parent test suite this test belongs to

{
  "testSuite": {
    "id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
    "type": "testSuite",
    "name": "customers.testSuite",
    "fullyQualifiedName": "postgres_prod.ecommerce.public.customers.testSuite"
  }
}

`parameterValues[]` (TestCaseParameterValue[])¶

Type: array of TestCaseParameterValue objects Required: No Description: Configured parameter values for this test

TestCaseParameterValue Object:

{
  "parameterValues": [
    {
      "name": "minValue",
      "value": "10000"
    },
    {
      "name": "maxValue",
      "value": "50000"
    }
  ]
}

Test Results Properties¶

`testCaseResult` (TestCaseResult)¶

Type: object Required: No (populated after execution) Description: Latest test execution result

TestCaseResult Object Properties:

Property	Type	Required	Description
`timestamp`	integer	Yes	Execution timestamp (epoch milliseconds)
`testCaseStatus`	TestCaseStatus enum	Yes	Success, Failed, Aborted, Queued
`result`	string	No	Human-readable result message
`sampleData`	string	No	Sample failing data (for failed tests)
`testResultValue`	array	No	Array of name-value result pairs
`passedRows`	integer	No	Number of rows that passed
`failedRows`	integer	No	Number of rows that failed

Example - Success:

{
  "testCaseResult": {
    "timestamp": 1704240000000,
    "testCaseStatus": "Success",
    "result": "Row count 32,450 is within range [10000-50000]",
    "testResultValue": [
      {
        "name": "actualRowCount",
        "value": "32450"
      },
      {
        "name": "minValue",
        "value": "10000"
      },
      {
        "name": "maxValue",
        "value": "50000"
      }
    ]
  }
}

Example - Failed:

{
  "testCaseResult": {
    "timestamp": 1704243600000,
    "testCaseStatus": "Failed",
    "result": "Row count 8,234 is below minimum threshold of 10,000",
    "testResultValue": [
      {
        "name": "actualRowCount",
        "value": "8234"
      },
      {
        "name": "minValue",
        "value": "10000"
      },
      {
        "name": "difference",
        "value": "-1766"
      }
    ]
  }
}

Example - Column Values Failed:

{
  "testCaseResult": {
    "timestamp": 1704247200000,
    "testCaseStatus": "Failed",
    "result": "342 rows contain email values outside allowed domain",
    "sampleData": "user@invalid-domain.xyz, test@bad-email.com, ...",
    "testResultValue": [
      {
        "name": "totalRows",
        "value": "10000"
      }
    ],
    "passedRows": 9658,
    "failedRows": 342
  }
}

`testCaseResults[]` (TestCaseResult[])¶

Type: array Required: No Description: Historical test execution results

{
  "testCaseResults": [
    {
      "timestamp": 1704240000000,
      "testCaseStatus": "Success",
      "result": "Row count: 32450"
    },
    {
      "timestamp": 1704153600000,
      "testCaseStatus": "Success",
      "result": "Row count: 31890"
    },
    {
      "timestamp": 1704067200000,
      "testCaseStatus": "Failed",
      "result": "Row count: 8234"
    }
  ]
}

Governance Properties¶

`owner` (EntityReference)¶

Type: object Required: No Description: User or team that owns this test case

{
  "owner": {
    "id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
    "type": "user",
    "name": "jane.doe",
    "displayName": "Jane Doe"
  }
}

Versioning Properties¶

`version` (entityVersion)¶

Type: number Required: Yes (system-managed) Description: Metadata version number

{
  "version": 1.5
}

Complete Examples¶

Table-Level Test Case¶

{
  "id": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c",
  "name": "customers_row_count_check",
  "fullyQualifiedName": "postgres_prod.ecommerce.public.customers.testSuite.customers_row_count_check",
  "displayName": "Customers Table Row Count Validation",
  "description": "Ensures the customers table has between 10,000 and 50,000 rows",
  "testDefinition": {
    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "type": "testDefinition",
    "name": "tableRowCountToBeBetween"
  },
  "entityLink": "table://postgres_prod.ecommerce.public.customers",
  "entityFQN": "postgres_prod.ecommerce.public.customers",
  "testSuite": {
    "id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
    "type": "testSuite",
    "name": "customers.testSuite"
  },
  "parameterValues": [
    {
      "name": "minValue",
      "value": "10000"
    },
    {
      "name": "maxValue",
      "value": "50000"
    }
  ],
  "testCaseResult": {
    "timestamp": 1704240000000,
    "testCaseStatus": "Success",
    "result": "Row count 32,450 is within range [10000-50000]",
    "testResultValue": [
      {
        "name": "actualRowCount",
        "value": "32450"
      }
    ]
  },
  "owner": {
    "id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
    "type": "user",
    "name": "jane.doe"
  },
  "version": 1.5
}

Column-Level Test Case¶

{
  "id": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c1d",
  "name": "email_unique_check",
  "fullyQualifiedName": "postgres_prod.ecommerce.public.customers.email.testSuite.email_unique_check",
  "displayName": "Email Column Uniqueness Check",
  "description": "Validates that all email addresses are unique",
  "testDefinition": {
    "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
    "type": "testDefinition",
    "name": "columnValuesToBeUnique"
  },
  "entityLink": "column://postgres_prod.ecommerce.public.customers.email",
  "entityFQN": "postgres_prod.ecommerce.public.customers.email",
  "testSuite": {
    "id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
    "type": "testSuite",
    "name": "customers.testSuite"
  },
  "parameterValues": [],
  "testCaseResult": {
    "timestamp": 1704240000000,
    "testCaseStatus": "Success",
    "result": "All 32,450 email values are unique",
    "testResultValue": [
      {
        "name": "totalRows",
        "value": "32450"
      },
      {
        "name": "uniqueCount",
        "value": "32450"
      },
      {
        "name": "duplicateCount",
        "value": "0"
      }
    ]
  },
  "version": 1.0
}

RDF Representation¶

Instance Example¶

@prefix om: <https://open-metadata.org/schema/> .
@prefix ex: <https://example.com/data/> .

ex:customersRowCountTest a om:TestCase ;
    om:name "customers_row_count_check" ;
    om:displayName "Customers Table Row Count Validation" ;
    om:basedOnDefinition ex:tableRowCountToBeBetween ;
    om:entityLink "table://postgres_prod.ecommerce.public.customers" ;
    om:belongsToTestSuite ex:customersTestSuite ;
    om:hasParameterValue [
        om:name "minValue" ;
        om:value "10000"
    ] ;
    om:hasParameterValue [
        om:name "maxValue" ;
        om:value "50000"
    ] ;
    om:hasTestResult ex:latestResult .

ex:latestResult a om:TestCaseResult ;
    om:timestamp "1704240000000"^^xsd:long ;
    om:testStatus om:SuccessStatus ;
    om:result "Row count: 32450" .

Relationships¶

Parent Entities¶

TestDefinition: The template this test is based on
TestSuite: The suite containing this test
Table or Column: The entity being tested

Associated Entities¶

Owner: User or team owning this test

Relationship Diagram¶

graph TD
    %% Hierarchical relationships (parent-child)
    TD[TestDefinition<br/>tableRowCountToBeBetween] -->|template for| TC[TestCase<br/>customers_row_count]
    TS[TestSuite<br/>customers.testSuite] -->|contains| TC

    %% Test targets
    TC -.->|tests| TBL[Table<br/>customers]
    TC2[TestCase<br/>email_unique] -.->|tests| COL[Column<br/>email]

    %% Hierarchy context
    SVC[DatabaseService] -->|contains| DB[Database]
    DB -->|contains| SCH[Schema]
    SCH -->|contains| TBL
    TBL -->|has| COL

    %% Cross-entity relationships - Governance
    USR[User] -.->|owns| TC

    %% Results and execution
    TC -->|produces| TR[TestResult<br/>Success/Failed]
    TC -->|triggers| ALERT[Alert<br/>on failure]

    %% Styling
    classDef definition fill:#8B5CF6,stroke:#7C3AED,color:#fff
    classDef testcase fill:#DC2626,stroke:#B91C1C,color:#fff
    classDef suite fill:#EF4444,stroke:#DC2626,color:#fff
    classDef data fill:#2563EB,stroke:#1E40AF,color:#fff
    classDef result fill:#F59E0B,stroke:#D97706,color:#fff
    classDef governance fill:#059669,stroke:#047857,color:#fff

    class TD definition
    class TC,TC2 testcase
    class TS suite
    class SVC,DB,SCH,TBL,COL data
    class TR,ALERT result
    class USR governance

Custom Properties¶

This entity supports custom properties through the extension field. Common custom properties include:

Data Classification: Sensitivity level
Cost Center: Billing allocation
Retention Period: Data retention requirements
Application Owner: Owning application/team

See Custom Properties for details on defining and using custom properties.

Followers¶

Users can follow test cases to receive notifications about test failures, parameter changes, and result trends. See Followers for details.

API Operations¶

List Test Cases¶

GET /v1/dataQuality/testCases
Query Parameters:
  - fields: Fields to include (owners, reviewers, entityStatus, testSuite, testDefinition, testSuites, incidentId, domains, tags, followers)
  - entityLink: Filter by entity link (e.g., table://service.database.schema.table)
  - entityFQN: Filter by entity FQN
  - testSuiteId: Filter by test suite ID
  - testCaseStatus: Filter by status (Success, Failed, Aborted, Queued)
  - testCaseType: Filter by type (column, table, all - default: all)
  - createdBy: Filter by creator username
  - includeAllTests: Include all tests at entity level (default: false)
  - limit: Number of results (1-1000000, default 10)
  - before: Cursor for previous page
  - after: Cursor for next page
  - include: all | deleted | non-deleted (default: non-deleted)

Response: TestCaseList

Example Request:

GET /v1/dataQuality/testCases?entityFQN=postgres_prod.ecommerce.public.customers&testCaseStatus=Failed&fields=testCaseResult,testSuite,owner&limit=50

Create Test Case¶

POST /v1/dataQuality/testCases
Content-Type: application/json

{
  "name": "customers_row_count_check",
  "displayName": "Customer Table Row Count Check",
  "description": "Validates that customer table row count is within expected range",
  "testDefinition": "tableRowCountToBeBetween",
  "entityLink": "<#E::table::postgres_prod.ecommerce.public.customers>",
  "testSuite": "postgres_prod.ecommerce.public.customers.testSuite",
  "parameterValues": [
    {
      "name": "minValue",
      "value": "10000"
    },
    {
      "name": "maxValue",
      "value": "50000"
    }
  ],
  "computePassedFailedRowCount": true,
  "owner": {
    "id": "user-uuid",
    "type": "user"
  },
  "tags": [
    {"tagFQN": "DataQuality.Critical"}
  ]
}

Response: TestCase

Create Multiple Test Cases¶

POST /v1/dataQuality/testCases/createMany
Content-Type: application/json

[
  {
    "name": "email_unique_check",
    "testDefinition": "columnValuesToBeUnique",
    "entityLink": "<#E::table::postgres_prod.ecommerce.public.customers::columns::email>",
    "testSuite": "postgres_prod.ecommerce.public.customers.testSuite"
  },
  {
    "name": "created_at_not_null",
    "testDefinition": "columnValuesToBeNotNull",
    "entityLink": "<#E::table::postgres_prod.ecommerce.public.customers::columns::created_at>",
    "testSuite": "postgres_prod.ecommerce.public.customers.testSuite"
  }
]

Response: List of created TestCases

Get Test Case by Name¶

GET /v1/dataQuality/testCases/name/{fqn}
Query Parameters:
  - fields: Fields to include (testCaseResult, testSuite, testDefinition, owner, tags)
  - include: all | deleted | non-deleted (default: non-deleted)

Response: TestCase

Example Request:

GET /v1/dataQuality/testCases/name/postgres_prod.ecommerce.public.customers.testSuite.customers_row_count_check?fields=testCaseResult,testSuite,owner

Get Test Case by ID¶

GET /v1/dataQuality/testCases/{id}
Query Parameters:
  - fields: Fields to include
  - include: all | deleted | non-deleted (default: non-deleted)

Response: TestCase

Update Test Case (Partial)¶

PATCH /v1/dataQuality/testCases/{id}
Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/parameterValues/0/value",
    "value": "15000"
  },
  {
    "op": "replace",
    "path": "/description",
    "value": "Updated description for row count validation"
  },
  {
    "op": "add",
    "path": "/tags/-",
    "value": {"tagFQN": "BusinessCritical"}
  }
]

Response: TestCase

Create or Update Test Case¶

PUT /v1/dataQuality/testCases
Content-Type: application/json

{
  "name": "customers_row_count_check",
  "testDefinition": "tableRowCountToBeBetween",
  "entityLink": "<#E::table::postgres_prod.ecommerce.public.customers>",
  "testSuite": "postgres_prod.ecommerce.public.customers.testSuite",
  "parameterValues": [
    {"name": "minValue", "value": "10000"},
    {"name": "maxValue", "value": "50000"}
  ]
}

Response: TestCase

Delete Test Case¶

DELETE /v1/dataQuality/testCases/{id}
Query Parameters:
  - hardDelete: true | false (default: false - soft delete)
  - recursive: true | false (default: false)

Response: TestCase

Delete Test Case (Async)¶

DELETE /v1/dataQuality/testCases/async/{id}
Query Parameters:
  - hardDelete: true | false (default: false)
  - recursive: true | false (default: false)

Response: Async deletion job details

Get Failed Rows Sample¶

GET /v1/dataQuality/testCases/{id}/failedRowsSample
Query Parameters:
  - limit: Number of failed rows to return (default: 25)

Response: Sample of failed rows with column values

Get Inspection Query¶

GET /v1/dataQuality/testCases/{id}/inspectionQuery

Response: SQL query to inspect failed test case data

Get Dimension Results¶

GET /v1/dataQuality/testCases/dimensionResults/{fqn}
Query Parameters:
  - startTs: Start timestamp (milliseconds)
  - endTs: End timestamp (milliseconds)

Response: Test case results grouped by data quality dimension

Get Dimension Summary¶

GET /v1/dataQuality/testCases/dimensionResults/{fqn}/dimensions
Query Parameters:
  - startTs: Start timestamp
  - endTs: End timestamp

Response: Summary of test results by dimension (Completeness, Accuracy, etc.)

Create Test Case Incident¶

POST /v1/dataQuality/testCases/testCaseIncidentStatus
Content-Type: application/json

{
  "testCaseReference": {
    "id": "test-case-uuid",
    "type": "testCase"
  },
  "stateId": 1234567890123,
  "incidentState": "New",
  "severity": "Severity1",
  "assignee": {
    "id": "user-uuid",
    "type": "user"
  },
  "reason": "Data quality anomaly detected in customer table"
}

Response: TestCaseIncidentStatus

Update Test Case Incident¶

PATCH /v1/dataQuality/testCases/testCaseIncidentStatus/{id}
Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/incidentState",
    "value": "Resolved"
  },
  {
    "op": "replace",
    "path": "/resolution",
    "value": "Data pipeline fixed and re-executed successfully"
  }
]

Response: TestCaseIncidentStatus

Get Logical Test Cases¶

GET /v1/dataQuality/testCases/logicalTestCases
Query Parameters:
  - testSuiteId: Logical test suite ID

Response: List of test cases in logical test suite

Export Test Case¶

GET /v1/dataQuality/testCases/name/{name}/export

Response: CSV file with test case details

Export Test Case (Async)¶

GET /v1/dataQuality/testCases/name/{name}/exportAsync

Response: Async export job details

Import Test Case¶

PUT /v1/dataQuality/testCases/name/{name}/import
Content-Type: multipart/form-data

file: [CSV file with test case data]
dryRun: false

Response: Import result

Import Test Case (Async)¶

PUT /v1/dataQuality/testCases/name/{name}/importAsync
Content-Type: multipart/form-data

file: [CSV file]
dryRun: false

Response: Async import job details

Get Test Case Version¶

GET /v1/dataQuality/testCases/{id}/versions/{version}

Response: TestCase (specific version)

Get Test Case Versions¶

GET /v1/dataQuality/testCases/{id}/versions

Response: EntityHistory (all versions)

Test Definition - Test templates
Test Suite - Test collections
Table - Table entity
Data Quality Overview - Quality framework

Test Case¶

Overview¶

Relationship Diagram¶

Schema Specifications¶

Use Cases¶

JSON Schema Specification¶

Core Properties¶

id (uuid)¶

name (entityName)¶

fullyQualifiedName (fullyQualifiedEntityName)¶

displayName¶

description (markdown)¶

Test Configuration Properties¶

testDefinition (EntityReference)¶

entityLink (uri)¶

entityFQN (string)¶

testSuite (EntityReference)¶

parameterValues[] (TestCaseParameterValue[])¶

Test Results Properties¶

testCaseResult (TestCaseResult)¶

testCaseResults[] (TestCaseResult[])¶

Governance Properties¶

owner (EntityReference)¶

Versioning Properties¶

version (entityVersion)¶

Complete Examples¶

Table-Level Test Case¶

Column-Level Test Case¶

RDF Representation¶

Instance Example¶

Relationships¶

Parent Entities¶

Associated Entities¶

Relationship Diagram¶

Custom Properties¶

Followers¶

API Operations¶

List Test Cases¶

Create Test Case¶

Create Multiple Test Cases¶

Get Test Case by Name¶

Get Test Case by ID¶

Update Test Case (Partial)¶

Create or Update Test Case¶

Delete Test Case¶

Delete Test Case (Async)¶

Get Failed Rows Sample¶

Get Inspection Query¶

Get Dimension Results¶

Get Dimension Summary¶

Create Test Case Incident¶

Update Test Case Incident¶

Get Logical Test Cases¶

Export Test Case¶

Export Test Case (Async)¶

Import Test Case¶

Import Test Case (Async)¶

Get Test Case Version¶

Get Test Case Versions¶

Related Documentation¶

`id` (uuid)¶

`name` (entityName)¶

`fullyQualifiedName` (fullyQualifiedEntityName)¶

`displayName`¶

`description` (markdown)¶

`testDefinition` (EntityReference)¶

`entityLink` (uri)¶

`entityFQN` (string)¶

`testSuite` (EntityReference)¶

`parameterValues[]` (TestCaseParameterValue[])¶

`testCaseResult` (TestCaseResult)¶

`testCaseResults[]` (TestCaseResult[])¶

`owner` (EntityReference)¶

`version` (entityVersion)¶