Skip to main content
PATCH
https://sandbox.getcollate.io/api
/
v1
/
dataQuality
/
testSuites
/
{id}
PATCH /v1/dataQuality/testSuites/{id}
from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

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

# Retrieve, modify, and update
ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
ts.description = "Updated: Critical data quality checks for production tables"
updated = TestSuites.update(ts)

print(f"Updated to version {updated.version}")

{
  "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",
  "description": "Updated: Critical data quality checks for production tables",
  "version": 0.2,
  "updatedAt": 1769982800000,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "executable": true
}

​
Update a Test Suite

Update a test suite’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

​
Update by ID

​
id
string
required
UUID of the test suite to update.

​
Update by Name

Use PATCH /v1/dataQuality/testSuites/name/{fqn} to update by fully qualified name.
​
fqn
string
required
Fully qualified name of the test suite.

​
Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
owners
array
Updated list of owner references.
PATCH /v1/dataQuality/testSuites/{id}
from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

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

# Retrieve, modify, and update
ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
ts.description = "Updated: Critical data quality checks for production tables"
updated = TestSuites.update(ts)

print(f"Updated to version {updated.version}")

{
  "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",
  "description": "Updated: Critical data quality checks for production tables",
  "version": 0.2,
  "updatedAt": 1769982800000,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "executable": true
}

​
Returns

Returns the updated test suite object with the new version number.

​
Response

​
id
string
Unique identifier for the test suite (UUID format).
​
name
string
Test suite name.
​
fullyQualifiedName
string
Fully qualified name of the test suite.
​
description
string
Updated description.
​
version
number
Incremented version number.

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this test suite
404NOT_FOUNDTest suite with given ID or FQN does not exist
409CONFLICTConcurrent modification detected