Retrieve configured asset type hierarchy mappings for the workspace.
Returns asset type hierarchy configurations, including details such as namespace prefix, display name, hierarchy levels, fallback asset type, name separator, and whether the configuration is active. The response includes both system-defined and custom configurations.
GET https://[hostname]/api/v1/openlineage/config/hierarchies
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| includeInactive | boolean | No |
Indicates whether to include inactive configurations in the results. |
| namespacePrefix | string | No |
Filters configurations by the specified namespace prefix. |
Request Examples
Each example shows how to call this endpoint with the documented method, URL, headers, and request body format.
curl -X GET "/api/v1/openlineage/config/hierarchies" \
-H "Authorization: Bearer <JWT>"
fetch("/api/v1/openlineage/config/hierarchies", {
method: "GET",
headers: {
"Authorization": "Bearer <JWT>"
}
})
.then(res => res.json())
.then(data => console.log(data));
import json
import requests
url = "/api/v1/openlineage/config/hierarchies"
headers = {
"Authorization": "Bearer <JWT>"
}
payload = None
response = requests.get(url, headers=headers)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
body := http.NoBody
req, _ := http.NewRequest("GET", "/api/v1/openlineage/config/hierarchies", body)
req.Header.Set("Authorization", "Bearer <JWT>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body2, _ := io.ReadAll(resp.Body)
fmt.Println(string(body2))
}
Success Responses
This payload returns the configured hierarchy mappings for the workspace.
It includes an array of configuration objects under configs and the total number of configurations under total.
Representative payload generated from the response schema.
{
"configs": [
{
"_id": "string",
"workspaceId": "string",
"namespacePrefix": "string",
"displayName": "string",
"description": "string",
"hierarchyLevels": [
{
"pattern": "string",
"assetTypeXref": "string",
"catalogType": "Datasource",
"parentLevel": 0,
"description": "string"
}
],
"fallbackAssetTypeXref": "string",
"nameSeparator": ".",
"isActive": true,
"priority": 0,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string"
}
],
"total": 0
}Error Responses
None