통합 카탈로그 엔터티 유형 수정¶
POST /api/v1/unified_catalog/entity_type_cfg/{entity_type_uuid}/modify
개요¶
통합 카탈로그 엔터티 유형을 수정합니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| entity_type_uuid | string | Y | 엔터티 유형 UUID |
본문 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | 엔터티 유형 표시 이름 빈 값 허용: False 최대 길이: 128 |
|
| description | string | 엔터티 유형 설명 빈 값 허용: False 최대 길이: 512 |
|
| extraConfig | json | 현재 워크스페이스에서의 엔터티 유형 추가 구성 빈 값 허용: False |
|
| healthConfig | json | 모든 유형에서 항상 구성 가능; system은 {"mode":"default"}, {"mode":"func","funcId":"xxx"}, {"mode":"disabled"}를 지원하며, 다른 유형은 func/disabled를 지원합니다. 백엔드 readiness 정리 진행 상황에 의존하지 않습니다. 빈 값 허용: 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수정을 지원합니다. - 모든 엔터티 유형은 항상
healthConfig수정을 지원합니다. system은default/func/disabled를 지원하며, 다른 유형은func/disabled를 지원합니다. 백엔드 readiness 정리 진행 상황에 의존하지 않습니다. - 사용자 정의 유형은
name,description,schemaDefine,viewDefine,extend를 수정할 수 있으며,extraConfig및customProperties도 동시에 수정할 수 있습니다. extraConfig는 전체 객체를 전달하는 것을 권장하며, 부분 patch 방식으로 값을 전달하는 것은 권장하지 않습니다.customProperties는 최상위custom_properties배열이 포함된 YAML 텍스트를 전달하는 것을 권장합니다. 이전 호출과의 호환성을 위해 최상위 YAML 배열도 허용됩니다.customProperties의 필드명은 현재 엔터티 유형 DataSchemaproperties의 필드와 중복될 수 없습니다. 필드는 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 '{"healthConfig":{"mode":"disabled"}}'