Unified Catalog Entity Type Creation¶

POST /api/v1/unified_catalog/entity_type_cfg/create

Overview¶

Create a Unified Catalog entity type.

Body Request Parameters¶

Parameter Name	Type	Required	Description
entityType	string	Y	Entity type code (globally unique) Allow empty: False Max length: 64
name	string		Entity type display name Allow empty: False Max length: 128
description	string		Entity type description Allow empty: False Max length: 512
extraConfig	json		Additional configuration for the entity type in the current workspace Allow empty: False
customProperties	string		DataSchema custom field YAML text appended to the entity type in the current workspace. It is recommended to use `custom_properties` as the top-level key Allow empty: False
schemaDefine	string		DataSchema YAML text Allow empty: False
viewDefine	string		UIView YAML text Allow empty: False
extend	json		Extension fields Allow empty: False

Parameter Supplementary Notes¶

Request Parameter Notes

Parameter Name	type	Required	Description
entityType	string	Yes	Entity type code, globally unique
name	string	No	Entity type display name
description	string	No	Entity type description
extraConfig	json	No	Additional configuration in the current workspace
healthConfig	json	No	The creation API does not process this field; configure health status after creation via the entity type modification API
customProperties	string	No	DataSchema custom field YAML text appended to the entity type in the current workspace. It is recommended to use `custom_properties` as the top-level key
schemaDefine	string	No	DataSchema YAML text
viewDefine	string	No	UIView YAML text
extend	json	No	Extension fields

Template Usage Notes

If schemaDefine or viewDefine is not provided, the system will automatically fill them from the default template.
{entity_type} in the default template will be replaced with the entityType of the current request.
If the caller wants to fully customize the template, they can directly pass the complete YAML text.
extraConfig and customProperties can be passed together during creation; both will be written to the current workspace entity type configuration.

Calling Notes

The OpenAPI does not support the deprecated entity type group parameter.
To create only a minimal entity type, you can pass only entityType.

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/unified_catalog/entity_type_cfg/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"entityType":"custom_demo","name":"自定义类型","description":"demo type"}'

Response¶

{
    "code": 200,
    "content": {
        "uuid": "cate_xxxx",
        "entityType": "custom_demo",
        "name": "自定义类型",
        "sourceType": "custom",
        "extraConfig": {},
        "customProperties": "",
        "effectiveSchemaDefine": "yaml text"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}