统一目录实体类型修改¶

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

概述¶

修改统一目录实体类型。

路由参数¶

参数名	类型	必选	说明
entity_type_uuid	string	Y	实体类型 UUID

Body 请求参数¶

参数名	类型	必选	说明
name	string		实体类型显示名允许为空: False 最大长度: 128
description	string		实体类型描述允许为空: False 最大长度: 512
extraConfig	json		实体类型在当前工作空间下的额外配置允许为空: False
customProperties	string		实体类型在当前工作空间下追加的 DataSchema 自定义字段 YAML 文本，推荐顶层为 custom_properties 允许为空: False
schemaDefine	string		DataSchema YAML 文本，仅自定义类型生效允许为空: False
viewDefine	string		UIView YAML 文本，仅自定义类型生效允许为空: False
extend	json		扩展字段允许为空: False

参数补充说明¶

路径参数说明

参数名	type	必选	说明
entity_type_uuid	string	是	目标实体类型 UUID

请求体参数说明

参数名	type	必选	说明
name	string	否	实体类型显示名
description	string	否	实体类型描述
extraConfig	json	否	当前工作空间下的额外配置
customProperties	string	否	实体类型在当前工作空间下追加的 DataSchema 自定义字段 YAML 文本，推荐顶层为 `custom_properties`
schemaDefine	string	否	DataSchema YAML 文本
viewDefine	string	否	UIView YAML 文本
extend	json	否	扩展字段

调用注意事项

默认类型支持修改 extraConfig 和 customProperties。
自定义类型可修改 name、description、schemaDefine、viewDefine、extend，也可同时修改 extraConfig 和 customProperties。
extraConfig 建议传完整对象，不建议按局部 patch 思路传值。
customProperties 推荐传包含顶层 custom_properties 数组的 YAML 文本；为兼容旧调用，也接受顶层 YAML 数组。
customProperties 字段名不能和当前实体类型 DataSchema properties 中的字段重复；字段按 YAML 文本保存，注释会原样保留。

请求例子¶

curl 'https://openapi.guance.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":"自定义类型2","extraConfig":{"telemetry":[]}}'

响应¶

{
    "code": 200,
    "content": {
        "uuid": "cate_xxxx",
        "entityType": "custom_demo",
        "name": "自定义类型2",
        "extraConfig": {
            "telemetry": []
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}