data-asset
Register data assets
Register data assets
POST
/
v0
/
data-assets
/
register
Register data assets
curl --request POST \
--url https://{hostname}.gable.ai/v0/data-assets/register \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"assets": [
{
"data_asset_resource_name": {
"data_source": "<string>",
"path": "<string>"
},
"schema": {
"type": "struct",
"name": "<string>",
"fields": [
{
"type": "struct",
"name": "<string>",
"fields": "<array>",
"alias": "<string>",
"doc": "<string>",
"logical": "<string>",
"optional": true
}
],
"alias": "<string>",
"doc": "<string>",
"logical": "<string>"
},
"fieldNameToDataAssetFieldProfileMap": {}
}
],
"prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
'import requests
url = "https://{hostname}.gable.ai/v0/data-assets/register"
payload = {
"assets": [
{
"data_asset_resource_name": {
"data_source": "<string>",
"path": "<string>"
},
"schema": {
"type": "struct",
"name": "<string>",
"fields": [
{
"type": "struct",
"name": "<string>",
"fields": "<array>",
"alias": "<string>",
"doc": "<string>",
"logical": "<string>",
"optional": True
}
],
"alias": "<string>",
"doc": "<string>",
"logical": "<string>"
},
"fieldNameToDataAssetFieldProfileMap": {}
}
],
"prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assets: [
{
data_asset_resource_name: {data_source: '<string>', path: '<string>'},
schema: {
type: 'struct',
name: '<string>',
fields: [
{
type: 'struct',
name: '<string>',
fields: '<array>',
alias: '<string>',
doc: '<string>',
logical: '<string>',
optional: true
}
],
alias: '<string>',
doc: '<string>',
logical: '<string>'
},
fieldNameToDataAssetFieldProfileMap: {}
}
],
prLink: 'https://github.com/fakeorg/fakerepo/pull/123'
})
};
fetch('https://{hostname}.gable.ai/v0/data-assets/register', 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://{hostname}.gable.ai/v0/data-assets/register",
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([
'assets' => [
[
'data_asset_resource_name' => [
'data_source' => '<string>',
'path' => '<string>'
],
'schema' => [
'type' => 'struct',
'name' => '<string>',
'fields' => [
[
'type' => 'struct',
'name' => '<string>',
'fields' => '<array>',
'alias' => '<string>',
'doc' => '<string>',
'logical' => '<string>',
'optional' => true
]
],
'alias' => '<string>',
'doc' => '<string>',
'logical' => '<string>'
],
'fieldNameToDataAssetFieldProfileMap' => [
]
]
],
'prLink' => 'https://github.com/fakeorg/fakerepo/pull/123'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{hostname}.gable.ai/v0/data-assets/register"
payload := strings.NewReader("{\n \"assets\": [\n {\n \"data_asset_resource_name\": {\n \"data_source\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"schema\": {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": \"<array>\",\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\",\n \"optional\": true\n }\n ],\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\"\n },\n \"fieldNameToDataAssetFieldProfileMap\": {}\n }\n ],\n \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n}")
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))
}HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/data-assets/register")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"assets\": [\n {\n \"data_asset_resource_name\": {\n \"data_source\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"schema\": {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": \"<array>\",\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\",\n \"optional\": true\n }\n ],\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\"\n },\n \"fieldNameToDataAssetFieldProfileMap\": {}\n }\n ],\n \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{hostname}.gable.ai/v0/data-assets/register")
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 \"assets\": [\n {\n \"data_asset_resource_name\": {\n \"data_source\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"schema\": {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": \"<array>\",\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\",\n \"optional\": true\n }\n ],\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\"\n },\n \"fieldNameToDataAssetFieldProfileMap\": {}\n }\n ],\n \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n}"
response = http.request(request)
puts response.read_body{
"asset_registration_outcomes": [
{
"data_asset_resource_name": {
"data_source": "<string>",
"path": "<string>"
},
"error": "<string>"
}
]
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}Authorizations
Body
application/json
Data Assets Registration Request
Response
Data Assets Registration Response
Show child attributes
Show child attributes
⌘I
Register data assets
curl --request POST \
--url https://{hostname}.gable.ai/v0/data-assets/register \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"assets": [
{
"data_asset_resource_name": {
"data_source": "<string>",
"path": "<string>"
},
"schema": {
"type": "struct",
"name": "<string>",
"fields": [
{
"type": "struct",
"name": "<string>",
"fields": "<array>",
"alias": "<string>",
"doc": "<string>",
"logical": "<string>",
"optional": true
}
],
"alias": "<string>",
"doc": "<string>",
"logical": "<string>"
},
"fieldNameToDataAssetFieldProfileMap": {}
}
],
"prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
'import requests
url = "https://{hostname}.gable.ai/v0/data-assets/register"
payload = {
"assets": [
{
"data_asset_resource_name": {
"data_source": "<string>",
"path": "<string>"
},
"schema": {
"type": "struct",
"name": "<string>",
"fields": [
{
"type": "struct",
"name": "<string>",
"fields": "<array>",
"alias": "<string>",
"doc": "<string>",
"logical": "<string>",
"optional": True
}
],
"alias": "<string>",
"doc": "<string>",
"logical": "<string>"
},
"fieldNameToDataAssetFieldProfileMap": {}
}
],
"prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assets: [
{
data_asset_resource_name: {data_source: '<string>', path: '<string>'},
schema: {
type: 'struct',
name: '<string>',
fields: [
{
type: 'struct',
name: '<string>',
fields: '<array>',
alias: '<string>',
doc: '<string>',
logical: '<string>',
optional: true
}
],
alias: '<string>',
doc: '<string>',
logical: '<string>'
},
fieldNameToDataAssetFieldProfileMap: {}
}
],
prLink: 'https://github.com/fakeorg/fakerepo/pull/123'
})
};
fetch('https://{hostname}.gable.ai/v0/data-assets/register', 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://{hostname}.gable.ai/v0/data-assets/register",
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([
'assets' => [
[
'data_asset_resource_name' => [
'data_source' => '<string>',
'path' => '<string>'
],
'schema' => [
'type' => 'struct',
'name' => '<string>',
'fields' => [
[
'type' => 'struct',
'name' => '<string>',
'fields' => '<array>',
'alias' => '<string>',
'doc' => '<string>',
'logical' => '<string>',
'optional' => true
]
],
'alias' => '<string>',
'doc' => '<string>',
'logical' => '<string>'
],
'fieldNameToDataAssetFieldProfileMap' => [
]
]
],
'prLink' => 'https://github.com/fakeorg/fakerepo/pull/123'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{hostname}.gable.ai/v0/data-assets/register"
payload := strings.NewReader("{\n \"assets\": [\n {\n \"data_asset_resource_name\": {\n \"data_source\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"schema\": {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": \"<array>\",\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\",\n \"optional\": true\n }\n ],\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\"\n },\n \"fieldNameToDataAssetFieldProfileMap\": {}\n }\n ],\n \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n}")
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))
}HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/data-assets/register")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"assets\": [\n {\n \"data_asset_resource_name\": {\n \"data_source\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"schema\": {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": \"<array>\",\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\",\n \"optional\": true\n }\n ],\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\"\n },\n \"fieldNameToDataAssetFieldProfileMap\": {}\n }\n ],\n \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{hostname}.gable.ai/v0/data-assets/register")
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 \"assets\": [\n {\n \"data_asset_resource_name\": {\n \"data_source\": \"<string>\",\n \"path\": \"<string>\"\n },\n \"schema\": {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"struct\",\n \"name\": \"<string>\",\n \"fields\": \"<array>\",\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\",\n \"optional\": true\n }\n ],\n \"alias\": \"<string>\",\n \"doc\": \"<string>\",\n \"logical\": \"<string>\"\n },\n \"fieldNameToDataAssetFieldProfileMap\": {}\n }\n ],\n \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n}"
response = http.request(request)
puts response.read_body{
"asset_registration_outcomes": [
{
"data_asset_resource_name": {
"data_source": "<string>",
"path": "<string>"
},
"error": "<string>"
}
]
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}