Replace the draft's contract
curl --request PUT \
--url https://api.example.com/api/data-apis/{name}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contract": {
"grain": "",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "",
"business_name": "<string>",
"nullable": true,
"is_key": false,
"filters": [],
"sortable": false,
"glossary_terms": [
{
"urn": "<string>",
"name": "<string>",
"definition": "<string>"
}
],
"tags": [
"<string>"
],
"sensitive": false,
"upstream": [
"<string>"
]
}
],
"default_sort": [
"<string>"
],
"default_page_size": 100,
"max_page_size": 1000,
"examples": [
{
"title": "<string>",
"params": {}
}
],
"context_pack": {
"artifact_id": "<string>",
"version": "<string>",
"name": "<string>"
},
"require_filter": false
}
}
'import requests
url = "https://api.example.com/api/data-apis/{name}/draft"
payload = { "contract": {
"grain": "",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "",
"business_name": "<string>",
"nullable": True,
"is_key": False,
"filters": [],
"sortable": False,
"glossary_terms": [
{
"urn": "<string>",
"name": "<string>",
"definition": "<string>"
}
],
"tags": ["<string>"],
"sensitive": False,
"upstream": ["<string>"]
}
],
"default_sort": ["<string>"],
"default_page_size": 100,
"max_page_size": 1000,
"examples": [
{
"title": "<string>",
"params": {}
}
],
"context_pack": {
"artifact_id": "<string>",
"version": "<string>",
"name": "<string>"
},
"require_filter": False
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contract: {
grain: '',
columns: [
{
name: '<string>',
type: '<string>',
description: '',
business_name: '<string>',
nullable: true,
is_key: false,
filters: [],
sortable: false,
glossary_terms: [{urn: '<string>', name: '<string>', definition: '<string>'}],
tags: ['<string>'],
sensitive: false,
upstream: ['<string>']
}
],
default_sort: ['<string>'],
default_page_size: 100,
max_page_size: 1000,
examples: [{title: '<string>', params: {}}],
context_pack: {artifact_id: '<string>', version: '<string>', name: '<string>'},
require_filter: false
}
})
};
fetch('https://api.example.com/api/data-apis/{name}/draft', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/data-apis/{name}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'contract' => [
'grain' => '',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '',
'business_name' => '<string>',
'nullable' => true,
'is_key' => false,
'filters' => [
],
'sortable' => false,
'glossary_terms' => [
[
'urn' => '<string>',
'name' => '<string>',
'definition' => '<string>'
]
],
'tags' => [
'<string>'
],
'sensitive' => false,
'upstream' => [
'<string>'
]
]
],
'default_sort' => [
'<string>'
],
'default_page_size' => 100,
'max_page_size' => 1000,
'examples' => [
[
'title' => '<string>',
'params' => [
]
]
],
'context_pack' => [
'artifact_id' => '<string>',
'version' => '<string>',
'name' => '<string>'
],
'require_filter' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/data-apis/{name}/draft"
payload := strings.NewReader("{\n \"contract\": {\n \"grain\": \"\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"\",\n \"business_name\": \"<string>\",\n \"nullable\": true,\n \"is_key\": false,\n \"filters\": [],\n \"sortable\": false,\n \"glossary_terms\": [\n {\n \"urn\": \"<string>\",\n \"name\": \"<string>\",\n \"definition\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"sensitive\": false,\n \"upstream\": [\n \"<string>\"\n ]\n }\n ],\n \"default_sort\": [\n \"<string>\"\n ],\n \"default_page_size\": 100,\n \"max_page_size\": 1000,\n \"examples\": [\n {\n \"title\": \"<string>\",\n \"params\": {}\n }\n ],\n \"context_pack\": {\n \"artifact_id\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"require_filter\": false\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.put("https://api.example.com/api/data-apis/{name}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contract\": {\n \"grain\": \"\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"\",\n \"business_name\": \"<string>\",\n \"nullable\": true,\n \"is_key\": false,\n \"filters\": [],\n \"sortable\": false,\n \"glossary_terms\": [\n {\n \"urn\": \"<string>\",\n \"name\": \"<string>\",\n \"definition\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"sensitive\": false,\n \"upstream\": [\n \"<string>\"\n ]\n }\n ],\n \"default_sort\": [\n \"<string>\"\n ],\n \"default_page_size\": 100,\n \"max_page_size\": 1000,\n \"examples\": [\n {\n \"title\": \"<string>\",\n \"params\": {}\n }\n ],\n \"context_pack\": {\n \"artifact_id\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"require_filter\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-apis/{name}/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contract\": {\n \"grain\": \"\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"\",\n \"business_name\": \"<string>\",\n \"nullable\": true,\n \"is_key\": false,\n \"filters\": [],\n \"sortable\": false,\n \"glossary_terms\": [\n {\n \"urn\": \"<string>\",\n \"name\": \"<string>\",\n \"definition\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"sensitive\": false,\n \"upstream\": [\n \"<string>\"\n ]\n }\n ],\n \"default_sort\": [\n \"<string>\"\n ],\n \"default_page_size\": 100,\n \"max_page_size\": 1000,\n \"examples\": [\n {\n \"title\": \"<string>\",\n \"params\": {}\n }\n ],\n \"context_pack\": {\n \"artifact_id\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"require_filter\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"version": 123,
"status": "draft",
"created_at": "2023-11-07T05:31:56Z",
"contract": {
"grain": "",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "",
"business_name": "<string>",
"nullable": true,
"is_key": false,
"filters": [
"eq"
],
"sortable": false,
"glossary_terms": [
{
"urn": "<string>",
"name": "<string>",
"definition": "<string>"
}
],
"tags": [
"<string>"
],
"sensitive": false,
"upstream": [
"<string>"
]
}
],
"default_sort": [
"<string>"
],
"default_page_size": 100,
"max_page_size": 1000,
"examples": [
{
"title": "<string>",
"params": {}
}
],
"context_pack": {
"artifact_id": "<string>",
"version": "<string>",
"name": "<string>"
},
"require_filter": false
},
"context_hash": "<string>",
"created_by": "<string>",
"published_by": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"retired_at": "2023-11-07T05:31:56Z",
"gaps": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Data API
Replace the draft's contract
Columns must be ones the source has; types always come from the source.
PUT
/
api
/
data-apis
/
{name}
/
draft
Replace the draft's contract
curl --request PUT \
--url https://api.example.com/api/data-apis/{name}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contract": {
"grain": "",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "",
"business_name": "<string>",
"nullable": true,
"is_key": false,
"filters": [],
"sortable": false,
"glossary_terms": [
{
"urn": "<string>",
"name": "<string>",
"definition": "<string>"
}
],
"tags": [
"<string>"
],
"sensitive": false,
"upstream": [
"<string>"
]
}
],
"default_sort": [
"<string>"
],
"default_page_size": 100,
"max_page_size": 1000,
"examples": [
{
"title": "<string>",
"params": {}
}
],
"context_pack": {
"artifact_id": "<string>",
"version": "<string>",
"name": "<string>"
},
"require_filter": false
}
}
'import requests
url = "https://api.example.com/api/data-apis/{name}/draft"
payload = { "contract": {
"grain": "",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "",
"business_name": "<string>",
"nullable": True,
"is_key": False,
"filters": [],
"sortable": False,
"glossary_terms": [
{
"urn": "<string>",
"name": "<string>",
"definition": "<string>"
}
],
"tags": ["<string>"],
"sensitive": False,
"upstream": ["<string>"]
}
],
"default_sort": ["<string>"],
"default_page_size": 100,
"max_page_size": 1000,
"examples": [
{
"title": "<string>",
"params": {}
}
],
"context_pack": {
"artifact_id": "<string>",
"version": "<string>",
"name": "<string>"
},
"require_filter": False
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contract: {
grain: '',
columns: [
{
name: '<string>',
type: '<string>',
description: '',
business_name: '<string>',
nullable: true,
is_key: false,
filters: [],
sortable: false,
glossary_terms: [{urn: '<string>', name: '<string>', definition: '<string>'}],
tags: ['<string>'],
sensitive: false,
upstream: ['<string>']
}
],
default_sort: ['<string>'],
default_page_size: 100,
max_page_size: 1000,
examples: [{title: '<string>', params: {}}],
context_pack: {artifact_id: '<string>', version: '<string>', name: '<string>'},
require_filter: false
}
})
};
fetch('https://api.example.com/api/data-apis/{name}/draft', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/data-apis/{name}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'contract' => [
'grain' => '',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
'description' => '',
'business_name' => '<string>',
'nullable' => true,
'is_key' => false,
'filters' => [
],
'sortable' => false,
'glossary_terms' => [
[
'urn' => '<string>',
'name' => '<string>',
'definition' => '<string>'
]
],
'tags' => [
'<string>'
],
'sensitive' => false,
'upstream' => [
'<string>'
]
]
],
'default_sort' => [
'<string>'
],
'default_page_size' => 100,
'max_page_size' => 1000,
'examples' => [
[
'title' => '<string>',
'params' => [
]
]
],
'context_pack' => [
'artifact_id' => '<string>',
'version' => '<string>',
'name' => '<string>'
],
'require_filter' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/data-apis/{name}/draft"
payload := strings.NewReader("{\n \"contract\": {\n \"grain\": \"\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"\",\n \"business_name\": \"<string>\",\n \"nullable\": true,\n \"is_key\": false,\n \"filters\": [],\n \"sortable\": false,\n \"glossary_terms\": [\n {\n \"urn\": \"<string>\",\n \"name\": \"<string>\",\n \"definition\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"sensitive\": false,\n \"upstream\": [\n \"<string>\"\n ]\n }\n ],\n \"default_sort\": [\n \"<string>\"\n ],\n \"default_page_size\": 100,\n \"max_page_size\": 1000,\n \"examples\": [\n {\n \"title\": \"<string>\",\n \"params\": {}\n }\n ],\n \"context_pack\": {\n \"artifact_id\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"require_filter\": false\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.put("https://api.example.com/api/data-apis/{name}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contract\": {\n \"grain\": \"\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"\",\n \"business_name\": \"<string>\",\n \"nullable\": true,\n \"is_key\": false,\n \"filters\": [],\n \"sortable\": false,\n \"glossary_terms\": [\n {\n \"urn\": \"<string>\",\n \"name\": \"<string>\",\n \"definition\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"sensitive\": false,\n \"upstream\": [\n \"<string>\"\n ]\n }\n ],\n \"default_sort\": [\n \"<string>\"\n ],\n \"default_page_size\": 100,\n \"max_page_size\": 1000,\n \"examples\": [\n {\n \"title\": \"<string>\",\n \"params\": {}\n }\n ],\n \"context_pack\": {\n \"artifact_id\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"require_filter\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-apis/{name}/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contract\": {\n \"grain\": \"\",\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"\",\n \"business_name\": \"<string>\",\n \"nullable\": true,\n \"is_key\": false,\n \"filters\": [],\n \"sortable\": false,\n \"glossary_terms\": [\n {\n \"urn\": \"<string>\",\n \"name\": \"<string>\",\n \"definition\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"sensitive\": false,\n \"upstream\": [\n \"<string>\"\n ]\n }\n ],\n \"default_sort\": [\n \"<string>\"\n ],\n \"default_page_size\": 100,\n \"max_page_size\": 1000,\n \"examples\": [\n {\n \"title\": \"<string>\",\n \"params\": {}\n }\n ],\n \"context_pack\": {\n \"artifact_id\": \"<string>\",\n \"version\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"require_filter\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"version": 123,
"status": "draft",
"created_at": "2023-11-07T05:31:56Z",
"contract": {
"grain": "",
"columns": [
{
"name": "<string>",
"type": "<string>",
"description": "",
"business_name": "<string>",
"nullable": true,
"is_key": false,
"filters": [
"eq"
],
"sortable": false,
"glossary_terms": [
{
"urn": "<string>",
"name": "<string>",
"definition": "<string>"
}
],
"tags": [
"<string>"
],
"sensitive": false,
"upstream": [
"<string>"
]
}
],
"default_sort": [
"<string>"
],
"default_page_size": 100,
"max_page_size": 1000,
"examples": [
{
"title": "<string>",
"params": {}
}
],
"context_pack": {
"artifact_id": "<string>",
"version": "<string>",
"name": "<string>"
},
"require_filter": false
},
"context_hash": "<string>",
"created_by": "<string>",
"published_by": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"retired_at": "2023-11-07T05:31:56Z",
"gaps": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
OAuth2AuthorizationCodeBearerAPIKeyHeader
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The API's name.
Pattern:
^[a-z][a-z0-9_]{1,62}$Body
application/json
Replace the draft's contract. Columns must stay a subset of the source's.
What a version promises. Frozen once the version is published.
Show child attributes
Show child attributes
Response
Successful Response
A version's lifecycle. Only draft can be edited.
Available options:
draft, published, retired What a version promises. Frozen once the version is published.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?