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	Extra configuration for the entity type in the current workspace Allow empty: False
healthConfig	json	Health configuration only supported for system types, structure is {"mode":"default"}, {"mode":"func","funcId":"xxx"}, or {"mode":"disabled"}; disabled means turning off health calculation Allow empty: False
customProperties	string	YAML text of DataSchema custom fields appended for the entity type in the current workspace, it is recommended that the top level be custom_properties 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	Extra configuration in the current workspace
customProperties	string	No	YAML text of DataSchema custom fields appended for the entity type in the current workspace, it is recommended that the top level be `custom_properties`
schemaDefine	string	No	DataSchema YAML text
viewDefine	string	No	UIView YAML text
extend	json	No	Extension fields

Call Notes

Default types support modifying extraConfig and customProperties.
System types additionally support modifying healthConfig; mode=disabled means turning off health calculation.
Custom types can modify name, description, schemaDefine, viewDefine, extend, and can also modify extraConfig and customProperties simultaneously.
It is recommended to pass the complete object for extraConfig, not recommended to pass values based on a partial patch approach.
For customProperties, it is recommended to pass YAML text containing a top-level custom_properties array; for compatibility with old calls, a top-level YAML array is also accepted.
Field names in customProperties cannot duplicate fields in the current entity type DataSchema properties; fields are saved as YAML text, comments will be preserved as-is.

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 '{"healthConfig":{"mode":"disabled"}}'

Response¶

{
    "code": 200,
    "content": {
        "uuid": "sys_system",
        "entityType": "system",
        "name": "System",
        "extraConfig": {},
        "healthConfig": {
            "mode": "disabled"
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}