Skip to main content
POST
/
v0
/
changelog
Create a new changelog event
curl --request POST \
  --url https://{hostname}.gable.ai/v0/changelog \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractVersion": "<string>",
  "contractFieldName": "<string>",
  "entityType": "DATA_CONTRACT",
  "violationType": "MISSING_REQUIRED_PROPERTY",
  "dataAssetResourceName": "<string>",
  "expectedValue": "<string>",
  "actualValue": "<string>",
  "contractName": "<string>",
  "contractDomain": "<string>",
  "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "VIOLATION",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prLink": "<string>"
}
'
{
  "changelogEventIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Changelog event to create

​
contractId
string<uuid>
required

Unique identifier for the contract in UUID format

​
contractVersion
string
required

Version of the contract

​
contractFieldName
string
required

Field of the contract where violation occured

​
entityType
enum<string>
required

The type of entity that the changelog event is associated with.

Available options:
DATA_CONTRACT
​
violationType
enum<string>
required

Type of violation

Available options:
MISSING_REQUIRED_PROPERTY,
INCOMPATIBLE_TYPE,
GREATER_THAN,
GREATER_THAN_OR_EQUAL_TO,
LESS_THAN,
LESS_THAN_OR_EQUAL_TO,
IS_NULL,
IS_NULL_THRESHOLD,
IS_NOT_EMPTY,
LENGTH,
LENGTH_GREATER_THAN,
LENGTH_GREATER_THAN_OR_EQUAL_TO,
LENGTH_LESS_THAN,
LENGTH_LESS_THAN_OR_EQUAL_TO,
MISSING_DATA_ASSET,
PII_DETECTED
​
dataAssetResourceName
string
required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

​
expectedValue
string
required

Expected value of the field

​
actualValue
string
required

actual value of the field

​
contractName
string

Name of the contract

​
contractDomain
string

Domain of the contract

​
dataAssetFieldProfileId
string<uuid>

Unique identifier for the data asset field in UUID format

​
eventType
enum<string>

The type of event that occurred

Available options:
VIOLATION
​
userId
string<uuid>

Unique identifier for the user in UUID format

​
prLink
string

Link to the pull request associated with the violation

Response

Changelog event(s) was successfully created

​
changelogEventIds
string<uuid>[]
required

List of changelog event IDs that were create