## Documentation Index Fetch the complete documentation index at: [/llms.txt](https://docs.gable.ai/llms.txt) Use this file to discover all available pages before exploring further. GET /v0/contracts/data-asset/{id} ### Try it Get the contract by darn #### cURL ``` curl --request GET \ --url https://demo-api.gable.ai/v0/contracts/data-asset/{id} \ --header 'X-API-KEY: ' ``` ``` import requests url = "https://demo-api.gable.ai/v0/contracts/data-asset/{id}" headers = {"X-API-KEY": ""} response = requests.get(url, headers=headers) print(response.text) ``` ``` const options = {method: 'GET', headers: {'X-API-KEY': ''}}; fetch('https://demo-api.gable.ai/v0/contracts/data-asset/{id}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err)); ``` ``` "https://demo-api.gable.ai/v0/contracts/data-asset/{id}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "X-API-KEY: " ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } } ``` ``` package main import ( "fmt" "net/http" "io" ) func main() { url := "https://demo-api.gable.ai/v0/contracts/data-asset/{id}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-KEY", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` ``` HttpResponse response = Unirest.get("https://demo-api.gable.ai/v0/contracts/data-asset/{id}") .header("X-API-KEY", "") .asString(); ``` ``` require 'uri' require 'net/http' url = URI("https://demo-api.gable.ai/v0/contracts/data-asset/{id}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-API-KEY"] = '' response = http.request(request) puts response.read_body ``` ### Responses 200 400 404 ``` [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "contractSpec": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "doc": "", "name": "", "namespace": "", "owner": "jsmith@example.com", "schema": [ { "type": "struct", "name": "", "fields": [ { "type": "struct", "name": "", "fields": "", "alias": "", "doc": "", "logical": "", "optional": true } ], "alias": "", "doc": "", "logical": "", "optional": true, "constraints": {} } ], "dataAssetResourceName": "", "dataAssetResourceNameList": [ "" ], "restrictPii": true }, "contractSpecRaw": "", "violations": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "timestamp": "2023-11-07T05:31:56Z", "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "contractVersion": "", "contractFieldName": "", "entityType": "DATA_CONTRACT", "dataAssetResourceName": "", "expectedValue": "", "actualValue": "", "eventTitle": "", "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "contractName": "", "contractDomain": "", "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "eventType": "VIOLATION", "prLink": "" } ], "parentRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "version": "", "gitHash": "", "gitRepo": "", "gitUser": "", "fileUri": "", "filePath": "", "reviewers": [ "" ], "mergedAt": "2023-11-07T05:31:56Z", "enforcementLevel": "INACTIVE", "lastEditorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "lastEditorEmail": "", "lastEditorFirstName": "", "lastEditorLastName": "", "lastEditorGithubHandle": "", "contractSpecFieldToViolationStatusMapping": {} } ] ``` ``` { "message": "", "id": 123, "title": "" } ``` ``` { "message": "", "id": 123, "title": "" } ``` #### Authorizations X-API-KEY string header required #### Path Parameters id string required asset name of data contract #### Query Parameters status string The status of the contract #### Response 200 application/json Successful response containing the contract by asset name id string required Unique identifier for the contract in UUID format status enum required status of the contract Available options: `ACTIVE`, `DEPRECATED`, `DRAFT`, `ARCHIVED` createdAt string required date time at which the contract was created updatedAt string required date time at which the contract was last updated contractSpec object required contract spec contractSpecRaw string required contract spec raw json violations object[] required List of contract violations parentRowId string Unique identifier for a contract's parent row id in UUID format version string Version of the contract (semantic versioning) gitHash string full length git hash corresponding to the commit this contract was added/updated Required string length: `40` gitRepo string full link to the git repo this contract lives in gitUser string git user who added/updated this contract fileUri string full link to the file in the repo that contains this contract filePath string path to the contract file from the root of the git repository reviewers string[] optional list of users who reviewed the merged PR that this contract added/updated in mergedAt string date time at which the PR that added/updated this contract was merged enforcementLevel enum default:INACTIVE alert level for contract Available options: `RECORD`, `NOTIFY`, `ALERT`, `BLOCK`, `INACTIVE` lastEditorUserId string | null Unique identifier for the user who last edited the contract through the UI lastEditorEmail string | null Email of the user who last edited the contract through the UI lastEditorFirstName string | null First name of the user who last edited the contract through the UI lastEditorLastName string | null Last name of the user who last edited the contract through the UI lastEditorGithubHandle string | null GitHub handle of the user who last edited the contract through the UI contractSpecFieldToViolationStatusMapping object Mapping of contract spec fields to a list of the violations currently applicable to them.