Skip to main content
GET
/
v0
/
contracts
Get all contracts
curl --request GET \
  --url https://{hostname}.gable.ai/v0/contracts \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": "<string>",
    "status": "ACTIVE",
    "gitHash": "<string>",
    "gitRepo": "<string>",
    "gitUser": "<string>",
    "fileUri": "<string>",
    "filePath": "<string>",
    "reviewers": [
      "<string>"
    ],
    "mergedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "contractSpec": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataAssetResourceName": "<string>",
      "dataAssetResourceNameList": [
        "<string>"
      ],
      "doc": "<string>",
      "name": "<string>",
      "namespace": "<string>",
      "owner": "[email protected]",
      "restrictPii": true,
      "schema": [
        {
          "type": "struct",
          "name": "<string>",
          "fields": [
            "<any>"
          ],
          "alias": "<string>",
          "doc": "<string>",
          "logical": "<string>",
          "optional": true,
          "constraints": {}
        }
      ]
    },
    "contractSpecRaw": "<string>",
    "enforcementLevel": "RECORD",
    "lastEditorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lastEditorEmail": "<string>",
    "lastEditorFirstName": "<string>",
    "lastEditorLastName": "<string>",
    "lastEditorGithubHandle": "<string>",
    "violations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventTitle": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contractVersion": "<string>",
        "contractFieldName": "<string>",
        "contractName": "<string>",
        "contractDomain": "<string>",
        "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entityType": "DATA_CONTRACT",
        "eventType": "VIOLATION",
        "violationType": "MISSING_REQUIRED_PROPERTY",
        "dataAssetResourceName": "<string>",
        "expectedValue": "<string>",
        "actualValue": "<string>",
        "prLink": "<string>"
      }
    ],
    "contractSpecFieldToViolationStatusMapping": {}
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
resourcesLocation
string
​
sourceType
enum<string>
Available options:
postgres,
mysql,
mssql,
json_schema,
avro,
protobuf,
python,
pyspark,
typescript,
java,
s3,
dataframe,
kotlin,
swift,
php,
golang
​
limit
integer
​
offset
integer
​
status
string

Response

  • object[]
  • object
​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
ACTIVE,
DEPRECATED,
DRAFT,
ARCHIVED
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
contractSpec
object
required
​
contractSpecRaw
string
required
​
violations
object[]
required
​
parentRowId
string<uuid>
​
version
string
​
gitHash
string
Required string length: 40
​
gitRepo
string<uri>
​
gitUser
string
​
fileUri
string<uri>
​
filePath
string
​
reviewers
string[]
​
mergedAt
string<date-time>
​
enforcementLevel
enum<string>
default:INACTIVE
Available options:
RECORD,
NOTIFY,
ALERT,
BLOCK,
INACTIVE
​
lastEditorUserId
string<uuid> | null
​
lastEditorEmail
string | null
​
lastEditorFirstName
string | null
​
lastEditorLastName
string | null
​
lastEditorGithubHandle
string | null
​
contractSpecFieldToViolationStatusMapping
object