Skip to content

Modify Unified Catalog Entity Type


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

Overview

Modify a unified catalog entity type.

Route Parameters

Parameter Type Required Description
entity_type_uuid string Y Entity type UUID

Body Request Parameters

Parameter Type Required Description
name string Display name of the entity type
Nullable: False
Max Length: 128
description string Description of the entity type
Nullable: False
Max Length: 512
extraConfig json Extra configuration for the entity type in the current workspace
Nullable: False
healthConfig json Always configurable for all types; system supports {"mode":"default"}, {"mode":"func","funcId":"xxx"}, {"mode":"disabled"}; other types support func/disabled; does not depend on backend readiness cleanup progress
Nullable: False
customProperties string DataSchema custom field YAML text appended to the entity type in the current workspace. It is recommended to have custom_properties as the top-level key
Nullable: False
schemaDefine string DataSchema YAML text, only effective for custom types
Nullable: False
viewDefine string UIView YAML text, only effective for custom types
Nullable: False
extend json Extension fields
Nullable: False

Additional Parameter Notes

Path Parameter Description

Parameter Type Required Description
entity_type_uuid string Yes Target entity type UUID

Request Body Parameter Description

Parameter Type Required Description
name string No Display name of the entity type
description string No Description of the entity type
extraConfig json No Extra configuration in the current workspace
customProperties string No DataSchema custom field YAML text appended to the entity type in the current workspace. It is recommended to have custom_properties as the top-level key
schemaDefine string No DataSchema YAML text
viewDefine string No UIView YAML text
extend json No Extension fields

Calling Notes

  • Default types support modifying extraConfig and customProperties.
  • All entity types support modifying healthConfig at any time: system supports default/func/disabled, other types support func/disabled; does not depend on backend readiness cleanup progress.
  • Custom types can modify name, description, schemaDefine, viewDefine, and extend, and can also modify extraConfig and customProperties simultaneously.
  • It is recommended to pass the complete object for extraConfig, rather than passing values in a partial patch manner.
  • It is recommended to pass a YAML text containing a top-level custom_properties array for customProperties; for compatibility with legacy calls, a top-level YAML array is also accepted.
  • Field names in customProperties must not conflict with fields in the properties of the current entity type's DataSchema; fields are saved as YAML text, and comments are 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"
}