Quality Rules

Get quality rule

get

Retrieve the specified quality rule by ID if the user has view permission.

Path parameters

idstringRequired

Rule ID

Responses

200

Quality rule response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/rules/{id}

HTTPcURLJavaScriptPython

GET /api/rules/{id} HTTP/1.1
Accept: */*

{
  "data": {
    "active": true,
    "domain_id": 1,
    "id": 11,
    "inserted_at": "2026-06-23T12:18:55",
    "name": "Null check",
    "updated_at": "2026-06-23T12:18:55",
    "version": 1
  },
  "user_permissions": {
    "manage_quality_rules": true
  }
}

Update quality rule

put

Update an existing quality rule using the provided data after permission checks.

Path parameters

idstringRequired

Rule ID

Body

application/json

Responses

200

Quality rule response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/api/rules/{id}

HTTPcURLJavaScriptPython

PUT /api/rules/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "rule": {
    "active": true,
    "business_concept_id": 42,
    "description": "Check for null values",
    "domain_id": 1,
    "name": "Null check"
  }
}

{
  "data": {
    "active": true,
    "domain_id": 1,
    "id": 11,
    "inserted_at": "2026-06-23T12:18:55",
    "name": "Null check",
    "updated_at": "2026-06-23T12:18:55",
    "version": 1
  },
  "user_permissions": {
    "manage_quality_rules": true
  }
}

Delete quality rule

delete

Delete the quality rule identified by ID if the current user has deletion permission.

Path parameters

idstringRequired

Rule ID

Responses

204

No content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

delete/api/rules/{id}

HTTPcURLJavaScriptPython

DELETE /api/rules/{id} HTTP/1.1
Accept: */*

No content

Update quality rule

patch

Update an existing quality rule using the provided data after permission checks.

Path parameters

idstringRequired

Rule ID

Body

application/json

Responses

200

Quality rule response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

patch/api/rules/{id}

HTTPcURLJavaScriptPython

PATCH /api/rules/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "rule": {
    "active": true,
    "business_concept_id": 42,
    "description": "Check for null values",
    "domain_id": 1,
    "name": "Null check"
  }
}

{
  "data": {
    "active": true,
    "domain_id": 1,
    "id": 11,
    "inserted_at": "2026-06-23T12:18:55",
    "name": "Null check",
    "updated_at": "2026-06-23T12:18:55",
    "version": 1
  },
  "user_permissions": {
    "manage_quality_rules": true
  }
}

Upload quality rules CSV

post

Upload a CSV file containing quality rules and process the records for ingestion.

Body

multipart/form-data

rulesstring · binaryRequired

Responses

200

Rule upload response

application/json

idsinteger[]Optional

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/rules/upload

HTTPcURLJavaScriptPython

POST /api/rules/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 161

{
  "rules": "name;domain_external_id;description;template;first_field;second_field;third_field\nRule name;Domain ext id;Rule description;Template name;1;aaa;bbb\n"
}

{
  "errors": [],
  "ids": [
    11,
    12
  ]
}

Search quality rules

post

Search quality rules using the request payload and return paginated results.

Query parameters

pageintegerOptional

Page number

sizeintegerOptional

Page size

Body

application/json

pageintegerOptional

Page number

Default: 0

sizeinteger · min: 1Optional

Page size

Default: 20

Responses

200

Rule search response

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/api/rules/search

HTTPcURLJavaScriptPython

POST /api/rules/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "filters": {
    "active": [
      true
    ]
  },
  "page": 0,
  "size": 20
}

{
  "data": [
    {
      "active": true,
      "domain_id": 1,
      "id": 11,
      "inserted_at": "2026-06-23T12:18:55",
      "name": "Null check",
      "updated_at": "2026-06-23T12:18:55",
      "updated_by": {},
      "version": 1
    }
  ],
  "filters": {},
  "user_permissions": {
    "manage_quality_rules": true
  }
}

List quality rules by business concept

get

Retrieve quality rules filtered by the specified business concept and authorize access where applicable.

Path parameters

business_concept_idstringRequired

Business concept ID

Responses

200

Quality rules response

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/rules/concept/{business_concept_id}

HTTPcURLJavaScriptPython

GET /api/rules/concept/{business_concept_id} HTTP/1.1
Accept: */*

{
  "data": [
    {
      "active": true,
      "domain_id": 1,
      "id": 11,
      "inserted_at": "2026-06-23T12:18:55",
      "name": "Null check",
      "updated_at": "2026-06-23T12:18:55",
      "version": 1
    }
  ],
  "user_permissions": {
    "manage_quality_rules": true
  }
}

Get rule filters

post

Return the available filter values for quality rule searches.

Body

application/json

Responses

200

Filter response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post/api/rule_filters/search

HTTPcURLJavaScriptPython

POST /api/rule_filters/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "filters": {
    "domain_id": [
      1,
      2
    ]
  }
}

{
  "filters": {
    "active": [
      true
    ]
  }
}

Reindex quality rule search

get

Trigger a full reindex of the quality rule search index for the current tenant.

Responses

202

Accepted

No content

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/rules/search/reindex_all

HTTPcURLJavaScriptPython

GET /api/rules/search/reindex_all HTTP/1.1
Accept: */*

No content

List quality rules

get

Retrieve all quality rules visible to the current user and include domain enrichment.

Responses

200

Quality rules response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/rules

HTTPcURLJavaScriptPython

GET /api/rules HTTP/1.1
Accept: */*

{
  "data": [
    {
      "active": true,
      "domain_id": 1,
      "id": 11,
      "inserted_at": "2026-06-23T12:18:55",
      "name": "Null check",
      "updated_at": "2026-06-23T12:18:55",
      "version": 1
    }
  ],
  "user_permissions": {
    "manage_quality_rules": true
  }
}

Create quality rule

post

Create a new quality rule from the provided payload after authorization.

Body

application/json

Responses

201

Quality rule response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/rules

HTTPcURLJavaScriptPython

POST /api/rules HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "rule": {
    "active": true,
    "business_concept_id": 42,
    "description": "Check for null values",
    "domain_id": 1,
    "name": "Null check"
  }
}

{
  "data": {
    "active": true,
    "domain_id": 1,
    "id": 11,
    "inserted_at": "2026-06-23T12:18:55",
    "name": "Null check",
    "updated_at": "2026-06-23T12:18:55",
    "version": 1
  },
  "user_permissions": {
    "manage_quality_rules": true
  }
}