Unified Catalog Entity Type Details¶

GET /api/v1/unified_catalog/entity_type_cfg/get

Overview¶

Get details of a single unified catalog entity type.

Query Request Parameters¶

Parameter Name	Type	Required	Description
entityTypeUUID	string		Entity type UUID. Pass `default` to return the custom entity type creation template. Allow empty: False
entityType	string		Entity type code. Allow empty: False

Parameter Supplementary Notes¶

Request Parameter Description

Parameter Name	type	Required	Description
entityTypeUUID	string	No	Entity type UUID
entityType	string	No	Entity type code

Call Notes

At least one of entityTypeUUID and entityType must be provided.
When entityTypeUUID=default, returns the custom entity type creation template. This template is status=3 data and will not appear in the entity type list.
If both parameters are provided, it is recommended to ensure they point to the same entity type.
The returned result includes schemaDefine, viewDefine, extraConfig.
Returns the current workspace's customProperties and the merged effectiveSchemaDefine.

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/unified_catalog/entity_type_cfg/get?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

Response¶

{
    "code": 200,
    "content": {
        "uuid": "sys_service",
        "entityType": "service",
        "name": "Service",
        "schemaDefine": "yaml text",
        "viewDefine": "yaml text",
        "extraConfig": {},
        "customProperties": "custom_properties:\\n  - name: business_owner\\n    type: string\\n",
        "effectiveSchemaDefine": "yaml text"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}