GET /v1/dataQuality/testSuites/{id}

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
print(f"{ts.displayName} (executable: {ts.executable})")

# Get by ID with fields
ts = TestSuites.retrieve(
    "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
    fields=["owners", "tests"]
)

# Get by fully qualified name
ts = TestSuites.retrieve_by_name("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")

import static org.openmetadata.sdk.fluent.TestSuites.*;

// Get by ID
var ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572");

// Get by name with fields
var ts = TestSuites.retrieveByName(
    "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "owners,tests"
);

# Get by ID
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572?fields=owners,tests" \
  -H "Authorization: Bearer {access_token}"

# Get by name
curl "{base_url}/api/v1/dataQuality/testSuites/name/b5fcae09-02c2-4c0b-8c4a-5b52d650e592" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "displayName": "Data Contract - dim_address_comprehensive_contract",
  "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "version": 0.1,
  "updatedAt": 1769982757893,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "executable": true
}

GET

dataQuality

testSuites

{id}

GET /v1/dataQuality/testSuites/{id}

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
print(f"{ts.displayName} (executable: {ts.executable})")

# Get by ID with fields
ts = TestSuites.retrieve(
    "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
    fields=["owners", "tests"]
)

# Get by fully qualified name
ts = TestSuites.retrieve_by_name("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")

import static org.openmetadata.sdk.fluent.TestSuites.*;

// Get by ID
var ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572");

// Get by name with fields
var ts = TestSuites.retrieveByName(
    "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "owners,tests"
);

# Get by ID
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572?fields=owners,tests" \
  -H "Authorization: Bearer {access_token}"

# Get by name
curl "{base_url}/api/v1/dataQuality/testSuites/name/b5fcae09-02c2-4c0b-8c4a-5b52d650e592" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "displayName": "Data Contract - dim_address_comprehensive_contract",
  "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "version": 0.1,
  "updatedAt": 1769982757893,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "executable": true
}

Retrieve a Test Suite

Get a single test suite by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the test suite to retrieve.

fields

string

Comma-separated list of fields to include: owners, tests.

include

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/dataQuality/testSuites/name/{fqn} to retrieve by fully qualified name.

fqn

string

required

Fully qualified name of the test suite.

fields

string

Comma-separated list of fields to include: owners, tests.

include

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/dataQuality/testSuites/{id}

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
print(f"{ts.displayName} (executable: {ts.executable})")

# Get by ID with fields
ts = TestSuites.retrieve(
    "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
    fields=["owners", "tests"]
)

# Get by fully qualified name
ts = TestSuites.retrieve_by_name("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")

import static org.openmetadata.sdk.fluent.TestSuites.*;

// Get by ID
var ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572");

// Get by name with fields
var ts = TestSuites.retrieveByName(
    "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "owners,tests"
);

# Get by ID
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572?fields=owners,tests" \
  -H "Authorization: Bearer {access_token}"

# Get by name
curl "{base_url}/api/v1/dataQuality/testSuites/name/b5fcae09-02c2-4c0b-8c4a-5b52d650e592" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "displayName": "Data Contract - dim_address_comprehensive_contract",
  "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
  "version": 0.1,
  "updatedAt": 1769982757893,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "executable": true
}

Returns

Returns a test suite object with all requested fields populated.

Response

string

Unique identifier for the test suite (UUID format).

name

string

Test suite name.

fullyQualifiedName

string

Fully qualified name of the test suite.

displayName

string

Human-readable display name.

description

string

Description of the test suite.

executable

boolean

Whether this is an executable or logical test suite.

version

number

Version number for the entity.

owners

array

List of owners. Only included when fields contains owners.

tests

array

List of test case references. Only included when fields contains tests.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this test suite
`404`	`NOT_FOUND`	Test suite with given ID or FQN does not exist

List Test Suites

Update a Test Suite

​Retrieve a Test Suite

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Test Suite

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling