Get violation

Get a single violation snapshot by its ID.

GET /api/data-readiness/violations/{violation_id}

Get violation

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/violations/{violation_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
  },
  "service": "<string>",
  "asset_fqn": "<string>",
  "asset_version": "<string>",
  "severity": "<string>",
  "status": "<string>",
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "display_name": "Missing Description",
  "database": "analytics",
  "schema": "public",
  "table": "customers",
  "column": "email",
  "details": {
    "actual": "null",
    "expected": "not_null"
  },
  "dq_rule_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resolved_by": "admin",
  "resolution_notes": "Added missing description to column"
}

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.

Path Parameters

violation_id · string<uuid> · required

Violation ID

Response

200

application/json

Successful Response

Response model for a single violation snapshot.

id · string<uuid> · required

Unique violation identifier

Example:

"550e8400-e29b-41d4-a716-446655440010"

name · string · required

Violation type name

Example:

"missing_description"

fqn · string · required

Fully qualified name

Example:

"violations.missing_description"

dimension · DimensionRef · object · required

Reference to the assessment dimension

Show child attributes

service · string · required

Data service name

Example:

"production_db"

asset_fqn · string · required

Fully qualified name of the asset

Example:

"production_db.analytics.public.customers.email"

asset_version · string · required

Version of the asset

Example:

"v1.0.0"

severity · string · required

Violation severity

Example:

"high"

status · string · required

Current violation status

Example:

"open"

workflow_run_id · string<uuid> · required

ID of the workflow run that detected this violation

Example:

"550e8400-e29b-41d4-a716-446655440012"

created_at · string · required

When the violation was created

Example:

"2024-01-15T10:30:00Z"

display_name · string | null

Human-readable name

Example:

"Missing Description"

database · string | null

Database name

Example:

"analytics"

schema · string | null

Schema name

Example:

"public"

table · string | null

Table name

Example:

"customers"

column · string | null

Column name

Example:

"email"

details · Details · object

Additional violation details

Example:

{ "actual": "null", "expected": "not_null" }

dq_rule_execution_id · string<uuid> | null

Link to DQ rule execution (nullable)

resolved_by · string | null

Username who resolved the violation

Example:

"admin"

resolution_notes · string | null

Notes about the resolution

Example:

"Added missing description to column"