Bulk store (upsert) metadata
curl --request POST \
--url https://api.example.com/utils/metadata/store \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Project-ID: <x-project-id>' \
--data '
{
"items": [
{
"resource_uri": "<string>",
"metadata": {
"name": "<string>",
"fully_qualified_name": "<string>",
"display_name": "<string>",
"description": "<string>",
"summary_text": "<string>",
"type": "column",
"data_type": "<string>",
"data_type_display": "<string>",
"ordinal_position": 123,
"nullable": true,
"constraint": {},
"column_relationships": [
{}
],
"precision": 123,
"scale": 123,
"data_length": 123,
"business_definition": "<string>",
"business_rules": "<string>",
"owners": [
{
"name": "<string>",
"type": "<string>",
"id": "<string>"
}
],
"extension": {},
"is_dq_tagged": true,
"is_pii_tagged": true,
"is_sensitivity_tagged": true,
"version": "<string>",
"tags": [
"<string>"
]
}
}
]
}
'import requests
url = "https://api.example.com/utils/metadata/store"
payload = { "items": [
{
"resource_uri": "<string>",
"metadata": {
"name": "<string>",
"fully_qualified_name": "<string>",
"display_name": "<string>",
"description": "<string>",
"summary_text": "<string>",
"type": "column",
"data_type": "<string>",
"data_type_display": "<string>",
"ordinal_position": 123,
"nullable": True,
"constraint": {},
"column_relationships": [{}],
"precision": 123,
"scale": 123,
"data_length": 123,
"business_definition": "<string>",
"business_rules": "<string>",
"owners": [
{
"name": "<string>",
"type": "<string>",
"id": "<string>"
}
],
"extension": {},
"is_dq_tagged": True,
"is_pii_tagged": True,
"is_sensitivity_tagged": True,
"version": "<string>",
"tags": ["<string>"]
}
}
] }
headers = {
"X-Project-ID": "<x-project-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Project-ID': '<x-project-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
resource_uri: '<string>',
metadata: {
name: '<string>',
fully_qualified_name: '<string>',
display_name: '<string>',
description: '<string>',
summary_text: '<string>',
type: 'column',
data_type: '<string>',
data_type_display: '<string>',
ordinal_position: 123,
nullable: true,
constraint: {},
column_relationships: [{}],
precision: 123,
scale: 123,
data_length: 123,
business_definition: '<string>',
business_rules: '<string>',
owners: [{name: '<string>', type: '<string>', id: '<string>'}],
extension: {},
is_dq_tagged: true,
is_pii_tagged: true,
is_sensitivity_tagged: true,
version: '<string>',
tags: ['<string>']
}
}
]
})
};
fetch('https://api.example.com/utils/metadata/store', 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/utils/metadata/store",
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([
'items' => [
[
'resource_uri' => '<string>',
'metadata' => [
'name' => '<string>',
'fully_qualified_name' => '<string>',
'display_name' => '<string>',
'description' => '<string>',
'summary_text' => '<string>',
'type' => 'column',
'data_type' => '<string>',
'data_type_display' => '<string>',
'ordinal_position' => 123,
'nullable' => true,
'constraint' => [
],
'column_relationships' => [
[
]
],
'precision' => 123,
'scale' => 123,
'data_length' => 123,
'business_definition' => '<string>',
'business_rules' => '<string>',
'owners' => [
[
'name' => '<string>',
'type' => '<string>',
'id' => '<string>'
]
],
'extension' => [
],
'is_dq_tagged' => true,
'is_pii_tagged' => true,
'is_sensitivity_tagged' => true,
'version' => '<string>',
'tags' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Project-ID: <x-project-id>"
],
]);
$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/utils/metadata/store"
payload := strings.NewReader("{\n \"items\": [\n {\n \"resource_uri\": \"<string>\",\n \"metadata\": {\n \"name\": \"<string>\",\n \"fully_qualified_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary_text\": \"<string>\",\n \"type\": \"column\",\n \"data_type\": \"<string>\",\n \"data_type_display\": \"<string>\",\n \"ordinal_position\": 123,\n \"nullable\": true,\n \"constraint\": {},\n \"column_relationships\": [\n {}\n ],\n \"precision\": 123,\n \"scale\": 123,\n \"data_length\": 123,\n \"business_definition\": \"<string>\",\n \"business_rules\": \"<string>\",\n \"owners\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"extension\": {},\n \"is_dq_tagged\": true,\n \"is_pii_tagged\": true,\n \"is_sensitivity_tagged\": true,\n \"version\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Project-ID", "<x-project-id>")
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.post("https://api.example.com/utils/metadata/store")
.header("X-Project-ID", "<x-project-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"resource_uri\": \"<string>\",\n \"metadata\": {\n \"name\": \"<string>\",\n \"fully_qualified_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary_text\": \"<string>\",\n \"type\": \"column\",\n \"data_type\": \"<string>\",\n \"data_type_display\": \"<string>\",\n \"ordinal_position\": 123,\n \"nullable\": true,\n \"constraint\": {},\n \"column_relationships\": [\n {}\n ],\n \"precision\": 123,\n \"scale\": 123,\n \"data_length\": 123,\n \"business_definition\": \"<string>\",\n \"business_rules\": \"<string>\",\n \"owners\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"extension\": {},\n \"is_dq_tagged\": true,\n \"is_pii_tagged\": true,\n \"is_sensitivity_tagged\": true,\n \"version\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/utils/metadata/store")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Project-ID"] = '<x-project-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"resource_uri\": \"<string>\",\n \"metadata\": {\n \"name\": \"<string>\",\n \"fully_qualified_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary_text\": \"<string>\",\n \"type\": \"column\",\n \"data_type\": \"<string>\",\n \"data_type_display\": \"<string>\",\n \"ordinal_position\": 123,\n \"nullable\": true,\n \"constraint\": {},\n \"column_relationships\": [\n {}\n ],\n \"precision\": 123,\n \"scale\": 123,\n \"data_length\": 123,\n \"business_definition\": \"<string>\",\n \"business_rules\": \"<string>\",\n \"owners\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"extension\": {},\n \"is_dq_tagged\": true,\n \"is_pii_tagged\": true,\n \"is_sensitivity_tagged\": true,\n \"version\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"fqn": "<string>",
"message": "<string>",
"version": "<string>",
"children": {}
}
],
"errors": [
{
"fqn": "<string>",
"detail": "<string>"
}
]
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}metadata
Bulk store (upsert) metadata
Create or update multiple metadata entities. Items are sorted by FQN depth so ancestors are processed first.
POST
/
utils
/
metadata
/
store
Bulk store (upsert) metadata
curl --request POST \
--url https://api.example.com/utils/metadata/store \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Project-ID: <x-project-id>' \
--data '
{
"items": [
{
"resource_uri": "<string>",
"metadata": {
"name": "<string>",
"fully_qualified_name": "<string>",
"display_name": "<string>",
"description": "<string>",
"summary_text": "<string>",
"type": "column",
"data_type": "<string>",
"data_type_display": "<string>",
"ordinal_position": 123,
"nullable": true,
"constraint": {},
"column_relationships": [
{}
],
"precision": 123,
"scale": 123,
"data_length": 123,
"business_definition": "<string>",
"business_rules": "<string>",
"owners": [
{
"name": "<string>",
"type": "<string>",
"id": "<string>"
}
],
"extension": {},
"is_dq_tagged": true,
"is_pii_tagged": true,
"is_sensitivity_tagged": true,
"version": "<string>",
"tags": [
"<string>"
]
}
}
]
}
'import requests
url = "https://api.example.com/utils/metadata/store"
payload = { "items": [
{
"resource_uri": "<string>",
"metadata": {
"name": "<string>",
"fully_qualified_name": "<string>",
"display_name": "<string>",
"description": "<string>",
"summary_text": "<string>",
"type": "column",
"data_type": "<string>",
"data_type_display": "<string>",
"ordinal_position": 123,
"nullable": True,
"constraint": {},
"column_relationships": [{}],
"precision": 123,
"scale": 123,
"data_length": 123,
"business_definition": "<string>",
"business_rules": "<string>",
"owners": [
{
"name": "<string>",
"type": "<string>",
"id": "<string>"
}
],
"extension": {},
"is_dq_tagged": True,
"is_pii_tagged": True,
"is_sensitivity_tagged": True,
"version": "<string>",
"tags": ["<string>"]
}
}
] }
headers = {
"X-Project-ID": "<x-project-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Project-ID': '<x-project-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
resource_uri: '<string>',
metadata: {
name: '<string>',
fully_qualified_name: '<string>',
display_name: '<string>',
description: '<string>',
summary_text: '<string>',
type: 'column',
data_type: '<string>',
data_type_display: '<string>',
ordinal_position: 123,
nullable: true,
constraint: {},
column_relationships: [{}],
precision: 123,
scale: 123,
data_length: 123,
business_definition: '<string>',
business_rules: '<string>',
owners: [{name: '<string>', type: '<string>', id: '<string>'}],
extension: {},
is_dq_tagged: true,
is_pii_tagged: true,
is_sensitivity_tagged: true,
version: '<string>',
tags: ['<string>']
}
}
]
})
};
fetch('https://api.example.com/utils/metadata/store', 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/utils/metadata/store",
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([
'items' => [
[
'resource_uri' => '<string>',
'metadata' => [
'name' => '<string>',
'fully_qualified_name' => '<string>',
'display_name' => '<string>',
'description' => '<string>',
'summary_text' => '<string>',
'type' => 'column',
'data_type' => '<string>',
'data_type_display' => '<string>',
'ordinal_position' => 123,
'nullable' => true,
'constraint' => [
],
'column_relationships' => [
[
]
],
'precision' => 123,
'scale' => 123,
'data_length' => 123,
'business_definition' => '<string>',
'business_rules' => '<string>',
'owners' => [
[
'name' => '<string>',
'type' => '<string>',
'id' => '<string>'
]
],
'extension' => [
],
'is_dq_tagged' => true,
'is_pii_tagged' => true,
'is_sensitivity_tagged' => true,
'version' => '<string>',
'tags' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Project-ID: <x-project-id>"
],
]);
$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/utils/metadata/store"
payload := strings.NewReader("{\n \"items\": [\n {\n \"resource_uri\": \"<string>\",\n \"metadata\": {\n \"name\": \"<string>\",\n \"fully_qualified_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary_text\": \"<string>\",\n \"type\": \"column\",\n \"data_type\": \"<string>\",\n \"data_type_display\": \"<string>\",\n \"ordinal_position\": 123,\n \"nullable\": true,\n \"constraint\": {},\n \"column_relationships\": [\n {}\n ],\n \"precision\": 123,\n \"scale\": 123,\n \"data_length\": 123,\n \"business_definition\": \"<string>\",\n \"business_rules\": \"<string>\",\n \"owners\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"extension\": {},\n \"is_dq_tagged\": true,\n \"is_pii_tagged\": true,\n \"is_sensitivity_tagged\": true,\n \"version\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Project-ID", "<x-project-id>")
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.post("https://api.example.com/utils/metadata/store")
.header("X-Project-ID", "<x-project-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"resource_uri\": \"<string>\",\n \"metadata\": {\n \"name\": \"<string>\",\n \"fully_qualified_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary_text\": \"<string>\",\n \"type\": \"column\",\n \"data_type\": \"<string>\",\n \"data_type_display\": \"<string>\",\n \"ordinal_position\": 123,\n \"nullable\": true,\n \"constraint\": {},\n \"column_relationships\": [\n {}\n ],\n \"precision\": 123,\n \"scale\": 123,\n \"data_length\": 123,\n \"business_definition\": \"<string>\",\n \"business_rules\": \"<string>\",\n \"owners\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"extension\": {},\n \"is_dq_tagged\": true,\n \"is_pii_tagged\": true,\n \"is_sensitivity_tagged\": true,\n \"version\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/utils/metadata/store")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Project-ID"] = '<x-project-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"resource_uri\": \"<string>\",\n \"metadata\": {\n \"name\": \"<string>\",\n \"fully_qualified_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary_text\": \"<string>\",\n \"type\": \"column\",\n \"data_type\": \"<string>\",\n \"data_type_display\": \"<string>\",\n \"ordinal_position\": 123,\n \"nullable\": true,\n \"constraint\": {},\n \"column_relationships\": [\n {}\n ],\n \"precision\": 123,\n \"scale\": 123,\n \"data_length\": 123,\n \"business_definition\": \"<string>\",\n \"business_rules\": \"<string>\",\n \"owners\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"extension\": {},\n \"is_dq_tagged\": true,\n \"is_pii_tagged\": true,\n \"is_sensitivity_tagged\": true,\n \"version\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"fqn": "<string>",
"message": "<string>",
"version": "<string>",
"children": {}
}
],
"errors": [
{
"fqn": "<string>",
"detail": "<string>"
}
]
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"details": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Request body for bulk store metadata.
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Was this page helpful?
⌘I

