curl --request GET \
--url https://api.example.com/api/data-readiness/violations/{violation_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/data-readiness/violations/{violation_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/data-readiness/violations/{violation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/data-readiness/violations/{violation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/data-readiness/violations/{violation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/data-readiness/violations/{violation_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-readiness/violations/{violation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440010",
"name": "missing_description",
"fqn": "violations.missing_description",
"dimension": {
"id": "550e8400-e29b-41d4-a716-446655440011",
"name": "accuracy",
"assessment_type": "data_quality",
"display_name": "Accuracy"
},
"service": "production_db",
"asset_fqn": "production_db.analytics.public.customers.email",
"asset_version": "v1.0.0",
"severity": "high",
"status": "open",
"workflow_run_id": "550e8400-e29b-41d4-a716-446655440012",
"created_at": "2024-01-15T10:30:00Z",
"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"
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}Get violation
Get a single violation snapshot by its ID.
curl --request GET \
--url https://api.example.com/api/data-readiness/violations/{violation_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/data-readiness/violations/{violation_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/data-readiness/violations/{violation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/data-readiness/violations/{violation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/data-readiness/violations/{violation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/data-readiness/violations/{violation_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-readiness/violations/{violation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "550e8400-e29b-41d4-a716-446655440010",
"name": "missing_description",
"fqn": "violations.missing_description",
"dimension": {
"id": "550e8400-e29b-41d4-a716-446655440011",
"name": "accuracy",
"assessment_type": "data_quality",
"display_name": "Accuracy"
},
"service": "production_db",
"asset_fqn": "production_db.analytics.public.customers.email",
"asset_version": "v1.0.0",
"severity": "high",
"status": "open",
"workflow_run_id": "550e8400-e29b-41d4-a716-446655440012",
"created_at": "2024-01-15T10:30:00Z",
"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"
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}Authorizations
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
Response
Successful Response
Response model for a single violation snapshot.
Unique violation identifier
"550e8400-e29b-41d4-a716-446655440010"
Violation type name
"missing_description"
Fully qualified name
"violations.missing_description"
Reference to the assessment dimension
Show child attributes
Show child attributes
Data service name
"production_db"
Fully qualified name of the asset
"production_db.analytics.public.customers.email"
Version of the asset
"v1.0.0"
Violation severity
"high"
Current violation status
"open"
ID of the workflow run that detected this violation
"550e8400-e29b-41d4-a716-446655440012"
When the violation was created
"2024-01-15T10:30:00Z"
Human-readable name
"Missing Description"
Database name
"analytics"
Schema name
"public"
Table name
"customers"
Column name
"email"
Additional violation details
{ "actual": "null", "expected": "not_null" }
Link to DQ rule execution (nullable)
Username who resolved the violation
"admin"
Notes about the resolution
"Added missing description to column"
Was this page helpful?

