Skip to main content
GET
/
api
/
data-readiness
/
violations
/
definitions
List violation definitions
curl --request GET \
  --url https://api.example.com/api/data-readiness/violations/definitions \
  --header 'Authorization: Bearer <token>'
{
  "definitions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "fqn": "<string>",
      "dimension": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "assessment_type": "<string>",
        "display_name": "Accuracy"
      },
      "default_severity": "<string>",
      "is_active": true,
      "display_name": "Missing Description",
      "description": "Triggered when a column lacks a description",
      "applicable_asset_types": [
        "table",
        "column"
      ]
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Response

Successful Response

Response model for listing violation definitions.

​
definitions
ViolationDefinitionResponse · object[]
required

List of violation definitions

​
total
integer
required

Total number of definitions

Example:

37