Unified Catalog Entity Details¶

POST /api/v1/unified_catalog/entity/get

Overview¶

Get details of a single unified catalog entity.

Body Request Parameters¶

Parameter Name	Type	Required	Description
urn	string	Y	Entity URN Allow Empty: False Example: urn:mysql:default:demo

Parameter Supplementary Description¶

Request Parameter Description

Parameter Name	type	Required	Description
urn	string	Yes	The unique URN of the target entity

Return Result Description

Returns entity basic information, attributes, teamInfo, tagsInfo.
systemRelationInfo is the list of one-hop direct system relationships for the current entity.

Call Notes

systemRelationInfo is not recursively expanded, only direct relationships are returned.
The attributes in the entity summaries at both ends of the relationship within systemRelationInfo are returned in full.

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/unified_catalog/entity/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:mysql:default:demo"}'

Response¶

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo",
        "entityType": "database",
        "name": "demo",
        "attributes": {
            "project": "demo",
            "env": "prod"
        },
        "teamInfo": [],
        "tagsInfo": [],
        "systemRelationInfo": []
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}