Skip to main content
PATCH
/
api
/
data-readiness
/
violations
/
{violation_id}
Update violation
curl --request PATCH \
  --url https://api.example.com/api/data-readiness/violations/{violation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resolution_notes": "Fixed by running PII enrichment workflow",
  "status": "resolved"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "updated_at": "<string>",
  "resolved_by": "admin",
  "resolution_notes": "Fixed by adding column description"
}

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

Body

application/json

Request model for updating a violation's status.

​
status
enum<string> | null

New status: open, resolved, acknowledged, false_positive

Available options:
open,
resolved,
acknowledged,
false_positive
​
resolution_notes
string | null

Notes about the resolution

Maximum string length: 1000

Response

Successful Response

Response model after updating a violation.

​
id
string<uuid>
required

Violation identifier

Example:

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

​
status
string
required

Updated status

Example:

"resolved"

​
updated_at
string
required

Timestamp when the violation was last updated

Example:

"2024-01-16T14:30:00Z"

​
resolved_by
string | null

Username who resolved

Example:

"admin"

​
resolution_notes
string | null

Notes about the resolution

Example:

"Fixed by adding column description"