createTestCase.json

{
  "$id": "https://open-metadata.org/schema/api/tests/createTestCase.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateTestCaseRequest",
  "description": "Test is a test definition to capture data quality tests.",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.tests.CreateTestCase",
  "javaInterfaces": ["org.openmetadata.schema.CreateEntity"],
  "properties": {
    "name": {
      "description": "Name that identifies this test case.",
      "$ref": "../../type/basic.json#/definitions/testCaseEntityName"
    },
    "description": {
      "description": "Description of the testcase.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "displayName": {
      "description": "Display Name that identifies this test.",
      "type": "string"
    },
    "testDefinition": {
      "description": "Fully qualified name of the test definition.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "entityLink": {
      "$ref": "../../type/basic.json#/definitions/entityLink"
    },
    "parameterValues": {
      "type": "array",
      "items": {
        "$ref": "../../tests/testCase.json#/definitions/testCaseParameterValue"
      }
    },
    "owners": {
      "description": "Owners of this test",
      "$ref": "../../type/entityReferenceList.json"
    },
    "reviewers": {
      "description": "Reviewers of this test",
      "$ref": "../../type/entityReferenceList.json"
    },
    "computePassedFailedRowCount": {
      "description": "Compute the passed and failed row count for the test case.",
      "type": "boolean",
      "default": false
    },
    "useDynamicAssertion": {
      "description": "If the test definition supports it, use dynamic assertion to evaluate the test case.",
      "type": "boolean",
      "default": false
    },
    "tags": {
      "description": "Tags for this test case. This is an inherited field from the parent entity and is not set directly on the test case.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": []
    },
    "dimensionColumns": {
      "description": "List of columns to group test results by dimensions. When specified, the test will be executed both overall and grouped by these columns to provide fine-grained data quality insights.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    },
    "topDimensions": {
      "description": "Number of top dimension values to show before grouping the rest as Others. Controls the cardinality of dimensional test results. Defaults to 5 when not specified.",
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 5
    },
    "testSuites": {
      "description": "Fully qualified names of logical test suites to attach this test case to on creation. Only non-basic (logical) test suites are accepted. Ignored on PATCH. Note: Test suite attachment is performed as a best-effort operation after test case creation.",
      "type": "array",
      "items": {
        "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
      },
      "uniqueItems": true,
      "default": []
    }
  },
  "required": ["name", "testDefinition", "entityLink"],
  "additionalProperties": false
}