Unified Catalog Entity Type Modification¶

POST /api/v1/unified_catalog/entity_type_cfg/{entity_type_uuid}/modify

Overview¶

Modify a unified catalog entity type.

Route Parameters¶

Parameter Name	Type	Required	Description
entity_type_uuid	string	Y	Entity Type UUID

Body Request Parameters¶

Parameter Name	Type	Description
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
schemaDefine	string	DataSchema YAML text, only effective for custom types Allow empty: False
viewDefine	string	UIView YAML text, only effective for custom types Allow empty: False
extend	json	Extension fields Allow empty: False

Parameter Supplementary Explanation¶

Path Parameter Explanation

Parameter Name	type	Required	Description
entity_type_uuid	string	Yes	Target entity type UUID

Request Body Parameter Explanation

Parameter Name	type	Required	Description
name	string	No	Entity type display name
description	string	No	Entity type description
extraConfig	json	No	Additional configuration for the current workspace
schemaDefine	string	No	DataSchema YAML text
viewDefine	string	No	UIView YAML text
extend	json	No	Extension fields

Call Notes

Default types only support modifying extraConfig.
Custom types can modify name, description, schemaDefine, viewDefine, extend, and can also modify extraConfig simultaneously.
It is recommended to pass the complete object for extraConfig, not recommended to pass values using a partial patch approach.

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/unified_catalog/entity_type_cfg/cate_xxxx/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"Custom Type 2","extraConfig":{"telemetry":[]}}'

Response¶

{
    "code": 200,
    "content": {
        "uuid": "cate_xxxx",
        "entityType": "custom_demo",
        "name": "Custom Type 2",
        "extraConfig": {
            "telemetry": []
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}