Creates or updates data assets

POST

data-assets

curl --request POST \
  --url https://{hostname}.gable.ai/v0/data-assets \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "dataAssetResourceName": "<string>",
    "domain": "<string>",
    "path": "<string>",
    "fields": [
      {
        "name": "<string>",
        "nativeDataType": "<string>",
        "type": {},
        "description": "<string>",
        "order": 123,
        "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "changeSummary": "<string>",
        "changeDescription": "<string>"
      }
    ],
    "description": "<string>",
    "rawSchema": "<string>",
    "prLink": "https://github.com/fakeorg/fakerepo/pull/123"
  }
]
'

import requests

url = "https://{hostname}.gable.ai/v0/data-assets"

payload = [
    {
        "dataAssetResourceName": "<string>",
        "domain": "<string>",
        "path": "<string>",
        "fields": [
            {
                "name": "<string>",
                "nativeDataType": "<string>",
                "type": {},
                "description": "<string>",
                "order": 123,
                "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "changeSummary": "<string>",
                "changeDescription": "<string>"
            }
        ],
        "description": "<string>",
        "rawSchema": "<string>",
        "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([
    {
      dataAssetResourceName: '<string>',
      domain: '<string>',
      path: '<string>',
      fields: [
        {
          name: '<string>',
          nativeDataType: '<string>',
          type: {},
          description: '<string>',
          order: 123,
          parentFieldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
          changeSummary: '<string>',
          changeDescription: '<string>'
        }
      ],
      description: '<string>',
      rawSchema: '<string>',
      prLink: 'https://github.com/fakeorg/fakerepo/pull/123'
    }
  ])
};

fetch('https://{hostname}.gable.ai/v0/data-assets', 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",
  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([
    [
        'dataAssetResourceName' => '<string>',
        'domain' => '<string>',
        'path' => '<string>',
        'fields' => [
                [
                                'name' => '<string>',
                                'nativeDataType' => '<string>',
                                'type' => [
                                                                
                                ],
                                'description' => '<string>',
                                'order' => 123,
                                'parentFieldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'changeSummary' => '<string>',
                                'changeDescription' => '<string>'
                ]
        ],
        'description' => '<string>',
        'rawSchema' => '<string>',
        '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"

	payload := strings.NewReader("[\n  {\n    \"dataAssetResourceName\": \"<string>\",\n    \"domain\": \"<string>\",\n    \"path\": \"<string>\",\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"nativeDataType\": \"<string>\",\n        \"type\": {},\n        \"description\": \"<string>\",\n        \"order\": 123,\n        \"parentFieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"changeSummary\": \"<string>\",\n        \"changeDescription\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"rawSchema\": \"<string>\",\n    \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n  }\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")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"dataAssetResourceName\": \"<string>\",\n    \"domain\": \"<string>\",\n    \"path\": \"<string>\",\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"nativeDataType\": \"<string>\",\n        \"type\": {},\n        \"description\": \"<string>\",\n        \"order\": 123,\n        \"parentFieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"changeSummary\": \"<string>\",\n        \"changeDescription\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"rawSchema\": \"<string>\",\n    \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/data-assets")

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  {\n    \"dataAssetResourceName\": \"<string>\",\n    \"domain\": \"<string>\",\n    \"path\": \"<string>\",\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"nativeDataType\": \"<string>\",\n        \"type\": {},\n        \"description\": \"<string>\",\n        \"order\": 123,\n        \"parentFieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"changeSummary\": \"<string>\",\n        \"changeDescription\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"rawSchema\": \"<string>\",\n    \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n  }\n]"

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataAssetResourceName": "<string>",
    "newVersionCreated": true
  }
]

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

dataAssetResourceName

string

required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

Pattern:

^(protobuf|avro|json_schema|java|postgres|mysql|mssql|snowflake|bigquery|python|pyspark|typescript|s3|dataframe|kotlin|swift|php)://(?=.*[a-zA-Z0-9])[a-zA-Z0-9_@\.:/-]+[:/](?=.*[a-zA-Z0-9])[a-zA-Z0-9 _\./-\{\}\-]+$

domain

string

required

The domain or category to which the data asset belongs.

path

string

required

The name or path identifying the data asset.

type

enum<string>

required

The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).

Available options:

postgres,

mysql,

mssql,

json_schema,

avro,

protobuf,

python,

pyspark,

typescript,

java,

s3,

dataframe,

kotlin,

swift,

php,

golang

fields

object[]

required

The fields of the data asset.

Show child attributes

description

string

A brief description of this particular version of the data asset.

rawSchema

string

The raw schema of the data asset from the source system. This can be the contents of a schema file or data from the information schema of a database. This is used to regenerate the schema of the data asset if needed.

prLink

string

Link to the PR that may have added or edited the data assets

Example:

"https://github.com/fakeorg/fakerepo/pull/123"

Response

Assets created or updated successfully

string<uuid>

required

ID of the created or updated data asset

versionId

string<uuid>

required

Version ID of the now current data asset

dataAssetResourceName

string

required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

Pattern:

^(protobuf|avro|json_schema|java|postgres|mysql|mssql|snowflake|bigquery|python|pyspark|typescript|s3|dataframe|kotlin|swift|php)://(?=.*[a-zA-Z0-9])[a-zA-Z0-9_@\.:/-]+[:/](?=.*[a-zA-Z0-9])[a-zA-Z0-9 _\./-\{\}\-]+$

newVersionCreated

boolean

required

Indicates whether a new version was created

Deletes data assetsDeletes data assets

⌘I

Creates or updates data assets

curl --request POST \
  --url https://{hostname}.gable.ai/v0/data-assets \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "dataAssetResourceName": "<string>",
    "domain": "<string>",
    "path": "<string>",
    "fields": [
      {
        "name": "<string>",
        "nativeDataType": "<string>",
        "type": {},
        "description": "<string>",
        "order": 123,
        "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "changeSummary": "<string>",
        "changeDescription": "<string>"
      }
    ],
    "description": "<string>",
    "rawSchema": "<string>",
    "prLink": "https://github.com/fakeorg/fakerepo/pull/123"
  }
]
'

import requests

url = "https://{hostname}.gable.ai/v0/data-assets"

payload = [
    {
        "dataAssetResourceName": "<string>",
        "domain": "<string>",
        "path": "<string>",
        "fields": [
            {
                "name": "<string>",
                "nativeDataType": "<string>",
                "type": {},
                "description": "<string>",
                "order": 123,
                "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "changeSummary": "<string>",
                "changeDescription": "<string>"
            }
        ],
        "description": "<string>",
        "rawSchema": "<string>",
        "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([
    {
      dataAssetResourceName: '<string>',
      domain: '<string>',
      path: '<string>',
      fields: [
        {
          name: '<string>',
          nativeDataType: '<string>',
          type: {},
          description: '<string>',
          order: 123,
          parentFieldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
          changeSummary: '<string>',
          changeDescription: '<string>'
        }
      ],
      description: '<string>',
      rawSchema: '<string>',
      prLink: 'https://github.com/fakeorg/fakerepo/pull/123'
    }
  ])
};

fetch('https://{hostname}.gable.ai/v0/data-assets', 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",
  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([
    [
        'dataAssetResourceName' => '<string>',
        'domain' => '<string>',
        'path' => '<string>',
        'fields' => [
                [
                                'name' => '<string>',
                                'nativeDataType' => '<string>',
                                'type' => [
                                                                
                                ],
                                'description' => '<string>',
                                'order' => 123,
                                'parentFieldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'changeSummary' => '<string>',
                                'changeDescription' => '<string>'
                ]
        ],
        'description' => '<string>',
        'rawSchema' => '<string>',
        '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"

	payload := strings.NewReader("[\n  {\n    \"dataAssetResourceName\": \"<string>\",\n    \"domain\": \"<string>\",\n    \"path\": \"<string>\",\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"nativeDataType\": \"<string>\",\n        \"type\": {},\n        \"description\": \"<string>\",\n        \"order\": 123,\n        \"parentFieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"changeSummary\": \"<string>\",\n        \"changeDescription\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"rawSchema\": \"<string>\",\n    \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n  }\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")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"dataAssetResourceName\": \"<string>\",\n    \"domain\": \"<string>\",\n    \"path\": \"<string>\",\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"nativeDataType\": \"<string>\",\n        \"type\": {},\n        \"description\": \"<string>\",\n        \"order\": 123,\n        \"parentFieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"changeSummary\": \"<string>\",\n        \"changeDescription\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"rawSchema\": \"<string>\",\n    \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/data-assets")

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  {\n    \"dataAssetResourceName\": \"<string>\",\n    \"domain\": \"<string>\",\n    \"path\": \"<string>\",\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"nativeDataType\": \"<string>\",\n        \"type\": {},\n        \"description\": \"<string>\",\n        \"order\": 123,\n        \"parentFieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"changeSummary\": \"<string>\",\n        \"changeDescription\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"rawSchema\": \"<string>\",\n    \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"\n  }\n]"

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataAssetResourceName": "<string>",
    "newVersionCreated": true
  }
]

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}