from metadata.sdk import configure
from metadata.sdk.entities import TestDefinitions

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
td = TestDefinitions.retrieve("a636d153-f1e8-45be-86d3-52aa6b71730d")
print(f"{td.name.root}: {getattr(td.description, 'root', td.description)}")

# Get by ID with fields
td = TestDefinitions.retrieve(
    "a636d153-f1e8-45be-86d3-52aa6b71730d",
    fields=["owners"]
)

# Get by name
td = TestDefinitions.retrieve_by_name("columnValueLengthsToBeBetween")
print(f"Entity type: {td.entityType}")
print(f"Parameters: {[p.name for p in td.parameterDefinition]}")

// client is an initialized OpenMetadataClient.
var testDefinition = client.testDefinitions().get("a636d153-f1e8-45be-86d3-52aa6b71730d");

// Get by name
var testDefinitionByName = client.testDefinitions().getByName("columnValueLengthsToBeBetween");

# Get by ID
curl "{base_url}/api/v1/dataQuality/testDefinitions/a636d153-f1e8-45be-86d3-52aa6b71730d" \
  -H "Authorization: Bearer {access_token}"

# Get by name
curl "{base_url}/api/v1/dataQuality/testDefinitions/name/columnValueLengthsToBeBetween" \
  -H "Authorization: Bearer {access_token}"

# With fields
curl "{base_url}/api/v1/dataQuality/testDefinitions/name/columnValueLengthsToBeBetween?fields=owners" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "a636d153-f1e8-45be-86d3-52aa6b71730d",
  "name": "columnValueLengthsToBeBetween",
  "displayName": "Column Value Lengths To Be Between",
  "fullyQualifiedName": "columnValueLengthsToBeBetween",
  "description": "This test definition validates that the lengths of column values are between a specified range...",
  "version": 0.1,
  "updatedAt": 1769982618104,
  "updatedBy": "admin",
  "testPlatforms": ["OpenMetadata"],
  "supportedDataTypes": ["STRING", "VARCHAR", "CHAR", "TEXT"],
  "parameterDefinition": [
    {
      "name": "minLength",
      "dataType": "INT",
      "required": false,
      "description": "The min length"
    },
    {
      "name": "maxLength",
      "dataType": "INT",
      "required": false,
      "description": "The max length"
    }
  ],
  "entityType": "COLUMN",
  "provider": "system",
  "deleted": false
}