Retrieve a specific asset type hierarchy configuration by its configuration ID
Returns the hierarchy configuration details for the specified configuration ID, including the namespace prefix, display name, hierarchy levels, fallback asset type, name separator, and configuration status.
GET https://[hostname]/api/v1/openlineage/config/hierarchies/{configId}
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| configId | string | Yes | Unique identifier of the hierarchy configuration to retrieve. |
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/{configId}" \
-H "Authorization: Bearer <JWT>"
fetch("/api/v1/openlineage/config/hierarchies/{configId}", {
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/{configId}"
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/{configId}", 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 hierarchy configuration for the specified configuration ID.
It includes namespace/display metadata, hierarchy levels, fallback settings, activation state, and audit fields.
Representative payload generated from the response schema.
{
"_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"
}Error Responses
This response indicates that no hierarchy configuration exists for the specified configuration ID.