Skip to main content
POST
/
v0
/
contract
Create a contract
curl --request POST \
  --url https://{hostname}.gable.ai/v0/contract \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": "<string>",
  "status": "ACTIVE",
  "gitHash": "<string>",
  "gitRepo": "<string>",
  "gitUser": "<string>",
  "reviewers": [
    "<string>"
  ],
  "filePath": "<string>",
  "mergedAt": "2023-11-07T05:31:56Z",
  "enforcementLevel": "RECORD",
  "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": {}
      }
    ]
  },
  "lastEditorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastEditorEmail": "<string>",
  "lastEditorFirstName": "<string>",
  "lastEditorLastName": "<string>",
  "lastEditorGithubHandle": "<string>"
}'
{
  "message": "<string>",
  "contractIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

X-API-KEY
string
header
required

Body

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

Response

200 - application/json
message
string
required
contractIds
string<uuid>[]
required