Business rules
Read access to business rules, their owners and roles, their linked glossary terms, and their latest test results. limit bounds the result set: it defaults to 50 and may not exceed 200. There is no paging - narrow the search with the filters instead.
Linked terms are returned in the glossaryPath|termName reference form, the same form the glossary endpoints return.
Search
Returns business rules matching the given filters
Request parameters
{
"name": "example",
"description": "example",
"freeText": "example",
"limit": 96
}
Responses
[
{
"id": 96,
"name": "example",
"description": "example",
"folder": "example",
"owners": [
"example"
],
"roles": [
"example"
],
"terms": [
"example"
],
"autoGenerateTests": true,
"testCaseCount": 96,
"passed": 96,
"failed": 96,
"error": 96,
"notExecuted": 96,
"passedResult": 16.0,
"failedResult": 16.0,
"errorResult": 16.0,
"notExecutedResult": 16.0,
"customFields": [
{
"name": "example",
"values": [
"example"
]
}
]
}
]
{
"status": 96,
"message": "example",
"errors": [
{
"entityId": "example",
"field": "example",
"message": "example"
}
]
}
{
"status": 96,
"message": "example",
"errors": [
{
"entityId": "example",
"field": "example",
"message": "example"
}
]
}
Get by id
Returns a single business rule with its results
Request parameters
Responses
{
"id": 96,
"name": "example",
"description": "example",
"folder": "example",
"owners": [
"example"
],
"roles": [
"example"
],
"terms": [
"example"
],
"autoGenerateTests": true,
"testCaseCount": 96,
"passed": 96,
"failed": 96,
"error": 96,
"notExecuted": 96,
"passedResult": 16.0,
"failedResult": 16.0,
"errorResult": 16.0,
"notExecutedResult": 16.0,
"customFields": [
{
"name": "example",
"values": [
"example"
]
}
]
}
{
"status": 96,
"message": "example",
"errors": [
{
"entityId": "example",
"field": "example",
"message": "example"
}
]
}
{
"status": 96,
"message": "example",
"errors": [
{
"entityId": "example",
"field": "example",
"message": "example"
}
]
}
09 October 2026