Test cases
Get by test suite
Returns test cases for test suite(s)
Request parameters
{
"names": [
"example"
]
}
Responses
{
"count": 96,
"results": [
{
"id": 96,
"testSuiteName": "example",
"connectionName": "example",
"description": "example",
"sql": "example",
"expectedResult": "example",
"lastResult": "example",
"lastExecution": "example",
"status": "example",
"executedBy": "example",
"owner": "example",
"info": "example",
"type": "example",
"comparisonSql": "example",
"comparisonConnectionName": "example",
"severity": "example",
"labels": [
"example"
],
"businessRules": [
"example"
],
"alertReceivers": [
{
"email": "example",
"scopes": [
"example"
]
}
]
}
]
}
Execute
Executes selected test(s) and returns result(s)
Request parameters
{
"testIds": [
96
],
"descriptionFilters": [
"example"
],
"sqlFilters": [
"example"
],
"connectionFilters": [
"example"
],
"testsuiteFilters": [
"example"
],
"labelFilters": [
"example"
],
"variables": "example",
"connection": "example",
"compareConnection": "example"
}
Responses
{
"count": 96,
"results": [
{
"id": 96,
"testSuiteName": "example",
"connectionName": "example",
"description": "example",
"sql": "example",
"expectedResult": "example",
"lastResult": "example",
"lastExecution": "example",
"status": "example",
"executedBy": "example",
"owner": "example",
"info": "example",
"type": "example",
"comparisonSql": "example",
"comparisonConnectionName": "example",
"severity": "example",
"labels": [
"example"
],
"businessRules": [
"example"
],
"alertReceivers": [
{
"email": "example",
"scopes": [
"example"
]
}
]
}
]
}
Search
Returns selected test(s) result(s)
Request parameters
Responses
Example request:
{
"testIds": [
24,
52,
67
],
"descriptionFilters": [
"price"
],
"sqlFilters": [
"price_usd"
],
"connectionFilters": [
"crypto"
],
"testsuiteFilters": [
"Crypto"
]
}
Example response:
{
"count": 3,
"results": [
{
"testSuiteName": "Crypto",
"connectionName": "Crypto",
"description": " BitCoin price test",
"sql": "SELECT price_usd FROM API.object WHERE id = 33422 ",
"expectedResult": ">0",
"lastResult": "22440.88",
"lastExecution": "2023-03-05 15:01:22",
"status": "ok",
"executedBy": "John",
"owner": "John",
"info": "g",
"type": "Query",
"labels": ["price", "btc"],
"businessRules": ["Price must be positive"],
"alertReceivers": [
{ "email": "alice@example.com", "scopes": ["FAILURE"] },
{ "email": "bob@example.com", "scopes": ["AUDIT", "FAILURE"] }
]
},
{
"testSuiteName": "Crypto",
"connectionName": "Crypto",
"description": " Dogecoin price test",
"sql": "SELECT price_usd FROM API.object WHERE id = 2 ",
"expectedResult": ">0",
"lastResult": "0.076033",
"lastExecution": "2023-03-05 15:01:22",
"status": "ok",
"executedBy": "John",
"owner": "John",
"type": "Query",
"businessRules": [],
"alertReceivers": []
}
]
}
businessRules - names of business rules linked to this test case.
alertReceivers - email recipients subscribed to alerts for this test case, with the scopes (
FAILURE,AUDIT) each subscription fires on. Covers both DQM-user subscriptions (resolved to the user's email) and bare-email subscriptions; webhook-target subscriptions are not included in this list.
History
Returns selected test execution history
Request parameters
Responses
[
{
"result": "example",
"executionTime": "example",
"executionEnd": "example",
"status": "example",
"executedBy": "example",
"durationInSeconds": 96,
"additionalResult": [
"example"
],
"disabled": true
}
]
21 May 2026