Create a new changelog event - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

POST / v0 /changelog

Try it

Create a new changelog event

cURL

curl --request POST \
  --url https://demo-api.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",
  "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>"
}
'

Python

import requests

url = "https://demo-api.gable.ai/v0/changelog"

payload = {
    "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contractVersion": "<string>",
    "contractFieldName": "<string>",
    "entityType": "DATA_CONTRACT",
    "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>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contractId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contractVersion: '<string>',
    contractFieldName: '<string>',
    entityType: 'DATA_CONTRACT',
    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>'
  })
};

fetch('https://demo-api.gable.ai/v0/changelog', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://demo-api.gable.ai/v0/changelog",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_POSTFIELDS => json_encode([\
    'contractId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',\
    'contractVersion' => '<string>',\
    'contractFieldName' => '<string>',\
    'entityType' => 'DATA_CONTRACT',\
    '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>'\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Content-Type: application/json",\
    "X-API-KEY: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://demo-api.gable.ai/v0/changelog"

payload := strings.NewReader("{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Java (Unirest)

HttpResponse<String> response = Unirest.post("https://demo-api.gable.ai/v0/changelog")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://demo-api.gable.ai/v0/changelog")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"}"

response = http.request(request)
puts response.read_body

Responses

200

{
  "changelogEventIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

500

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY - string, header required

Body

application/json

Changelog event to create

object
object[]
contractId: string, 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 occurred
entityType: enum, required - The type of entity associated with the changelog event. Available options: DATA_CONTRACT
violationType: enum, 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_NOT_EMPTY, LENGTH, 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, required - Name of the contract
contractDomain: string, required - Domain of the contract
dataAssetFieldProfileId: string, required - Unique identifier for the data asset field in UUID format
eventType: enum, required - Type of event that occurred. Available options: VIOLATION
userId: string, required - Unique identifier for the user in UUID format
prLink: string, required - Link to the pull request associated with the violation.