List metadata entities
curl --request GET \
--url https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query \
--header 'Authorization: Bearer <token>' \
--header 'X-Project-ID: <x-project-id>'import requests
url = "https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query"
headers = {
"X-Project-ID": "<x-project-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Project-ID': '<x-project-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query', 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/{resource_type}/{resource_uri}/metadata/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Project-ID", "<x-project-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query")
.header("X-Project-ID", "<x-project-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Project-ID"] = '<x-project-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"pagination": {
"offset": 123,
"limit": 123,
"total": 123
},
"results": [
{
"id": "<string>",
"name": "<string>",
"fully_qualified_name": "<string>",
"resource_uri": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"version": "<string>",
"version_major": 123,
"version_minor": 123,
"version_change_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"updated_by": "<string>",
"display_name": "<string>",
"description": "<string>",
"summary_text": "<string>",
"service_name": "<string>",
"owners": [
{
"name": "<string>",
"type": "<string>",
"id": "<string>"
}
],
"extension": {},
"schema_definition": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_dq_tagged": false,
"is_pii_tagged": false,
"is_sensitivity_tagged": false,
"tags": [
{
"tag_id": "<string>",
"tag_fqn": "<string>",
"category_name": "<string>",
"tag_name": "<string>",
"tag_description": "<string>"
}
],
"children": [
"<unknown>"
],
"children_total": 123,
"table_type": "<string>",
"row_count": 123,
"column_count": 123,
"table_count": 123,
"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>",
"change_description": {
"fields_added": [
{
"field_name": "<string>"
}
],
"fields_updated": [
{
"field_name": "<string>"
}
],
"fields_deleted": [
{
"field_name": "<string>"
}
],
"previous_version": "<string>"
},
"change_summary": {},
"changed_by": [
"<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
List metadata entities
Returns a paginated list of metadata entities under the resource, with filtering and sorting.
GET
/
utils
/
{resource_type}
/
{resource_uri}
/
metadata
/
query
List metadata entities
curl --request GET \
--url https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query \
--header 'Authorization: Bearer <token>' \
--header 'X-Project-ID: <x-project-id>'import requests
url = "https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query"
headers = {
"X-Project-ID": "<x-project-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Project-ID': '<x-project-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query', 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/{resource_type}/{resource_uri}/metadata/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Project-ID", "<x-project-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query")
.header("X-Project-ID", "<x-project-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Project-ID"] = '<x-project-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"pagination": {
"offset": 123,
"limit": 123,
"total": 123
},
"results": [
{
"id": "<string>",
"name": "<string>",
"fully_qualified_name": "<string>",
"resource_uri": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"version": "<string>",
"version_major": 123,
"version_minor": 123,
"version_change_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"updated_by": "<string>",
"display_name": "<string>",
"description": "<string>",
"summary_text": "<string>",
"service_name": "<string>",
"owners": [
{
"name": "<string>",
"type": "<string>",
"id": "<string>"
}
],
"extension": {},
"schema_definition": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_dq_tagged": false,
"is_pii_tagged": false,
"is_sensitivity_tagged": false,
"tags": [
{
"tag_id": "<string>",
"tag_fqn": "<string>",
"category_name": "<string>",
"tag_name": "<string>",
"tag_description": "<string>"
}
],
"children": [
"<unknown>"
],
"children_total": 123,
"table_type": "<string>",
"row_count": 123,
"column_count": 123,
"table_count": 123,
"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>",
"change_description": {
"fields_added": [
{
"field_name": "<string>"
}
],
"fields_updated": [
{
"field_name": "<string>"
}
],
"fields_deleted": [
{
"field_name": "<string>"
}
],
"previous_version": "<string>"
},
"change_summary": {},
"changed_by": [
"<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
Query Parameters
Filter by asset type Asset type discriminator values.
Available options:
database, database_schema, table, column Text search across name and description
FQN prefix for hierarchical scoping (direct children only)
Sort field: name, created_at, ordinal_position
Sort order: asc or desc
Max results per page
Required range:
1 <= x <= 200Pagination offset
Required range:
x >= 0Was this page helpful?
⌘I

