curl --request GET \
--url https://api.example.com/api/dataproduct/by-domain \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/dataproduct/by-domain"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/dataproduct/by-domain', 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/dataproduct/by-domain",
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>"
],
]);
$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/api/dataproduct/by-domain"
req, _ := http.NewRequest("GET", url, nil)
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/api/dataproduct/by-domain")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/dataproduct/by-domain")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"domain_urn": "<string>",
"total": 0,
"count": 0,
"dataproducts": [
{
"urn": "<string>",
"id": "",
"name": "",
"description": "",
"external_url": "",
"asset_count": 0,
"domain": {
"urn": "",
"name": ""
},
"tags": [
"<string>"
],
"glossary_terms": [
"<string>"
],
"owners": [
"<string>"
],
"docs": [
{
"type": "<string>",
"url": "<string>",
"description": "<string>",
"urn": "<string>",
"title": "<string>",
"subtype": "<string>",
"snippet": "<string>",
"tags": [
"<string>"
],
"glossary_terms": [
"<string>"
]
}
]
}
],
"domain_docs": [
{
"type": "<string>",
"url": "<string>",
"description": "<string>",
"urn": "<string>",
"title": "<string>",
"subtype": "<string>",
"snippet": "<string>",
"tags": [
"<string>"
],
"glossary_terms": [
"<string>"
]
}
]
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Retrieves data products in a domain
Retrieves the data products assigned to a domain, each with its catalog description and documentation links, plus the documents filed under the domain.
curl --request GET \
--url https://api.example.com/api/dataproduct/by-domain \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/dataproduct/by-domain"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/dataproduct/by-domain', 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/dataproduct/by-domain",
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>"
],
]);
$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/api/dataproduct/by-domain"
req, _ := http.NewRequest("GET", url, nil)
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/api/dataproduct/by-domain")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/dataproduct/by-domain")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"domain_urn": "<string>",
"total": 0,
"count": 0,
"dataproducts": [
{
"urn": "<string>",
"id": "",
"name": "",
"description": "",
"external_url": "",
"asset_count": 0,
"domain": {
"urn": "",
"name": ""
},
"tags": [
"<string>"
],
"glossary_terms": [
"<string>"
],
"owners": [
"<string>"
],
"docs": [
{
"type": "<string>",
"url": "<string>",
"description": "<string>",
"urn": "<string>",
"title": "<string>",
"subtype": "<string>",
"snippet": "<string>",
"tags": [
"<string>"
],
"glossary_terms": [
"<string>"
]
}
]
}
],
"domain_docs": [
{
"type": "<string>",
"url": "<string>",
"description": "<string>",
"urn": "<string>",
"title": "<string>",
"subtype": "<string>",
"snippet": "<string>",
"tags": [
"<string>"
],
"glossary_terms": [
"<string>"
]
}
]
}{
"error": "<string>",
"code": 500
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
URN of the domain to list data products for, such as urn:li:domain:finance.
Free-text filter over the data products. Use * for all of them.
Maximum number of data products to return.
1 <= x <= 200Maximum number of domain documents to return. Use 0 to skip them.
0 <= x <= 100Response
Retrieved data products successfully.
Data products in a domain, together with the domain's documents.
URN of the domain you queried.
Total number of matching data products in the catalog.
Number of data products in this response.
Data products in the domain, each with its description and docs.
Show child attributes
Show child attributes
DataHub documents filed under the domain. Documents attach to a domain rather than to an individual data product, so they apply to every product listed here.
Show child attributes
Show child attributes
Was this page helpful?

