콘텐츠로 이동

통합 카탈로그 엔터티 유형 생성¶

POST /api/v1/unified_catalog/entity_type_cfg/create

개요¶

통합 카탈로그 엔터티 유형을 생성합니다.

Body 요청 매개변수¶

매개변수명	유형	필수	설명
entityType	string	Y	엔터티 유형 코드(전역 고유) null 허용: False 최대 길이: 64
name	string		엔터티 유형 표시 이름 null 허용: False 최대 길이: 128
description	string		엔터티 유형 설명 null 허용: False 최대 길이: 512
extraConfig	json		현재 워크스페이스에서의 엔터티 유형 추가 설정 null 허용: False
customProperties	string		현재 워크스페이스에서 엔터티 유형에 추가할 DataSchema 사용자 정의 필드 YAML 텍스트, 최상위는 `custom_properties` 권장 null 허용: False
schemaDefine	string		DataSchema YAML 텍스트 null 허용: False
viewDefine	string		UIView YAML 텍스트 null 허용: False
extend	json		확장 필드 null 허용: False

매개변수 추가 설명¶

요청 매개변수 설명

매개변수명	type	필수	설명
entityType	string	예	엔터티 유형 코드, 전역 고유
name	string	아니요	엔터티 유형 표시 이름
description	string	아니요	엔터티 유형 설명
extraConfig	json	아니요	현재 워크스페이스에서의 추가 설정
healthConfig	json	아니요	생성 API는 이 필드를 처리하지 않음. 생성 성공 후 엔터티 유형 수정 API를 통해 상태 구성
customProperties	string	아니요	현재 워크스페이스에서 엔터티 유형에 추가할 DataSchema 사용자 정의 필드 YAML 텍스트, 최상위는 `custom_properties` 권장
schemaDefine	string	아니요	DataSchema YAML 텍스트
viewDefine	string	아니요	UIView YAML 텍스트
extend	json	아니요	확장 필드

템플릿 사용 설명

schemaDefine 또는 viewDefine을 전달하지 않으면 시스템이 기본 템플릿에서 자동으로 채웁니다.
기본 템플릿의 {entity_type}은 현재 요청의 entityType으로 대체됩니다.
호출자가 템플릿을 완전히 사용자 정의하려면 전체 YAML 텍스트를 직접 전달할 수 있습니다.
생성 시 extraConfig와 customProperties를 동시에 전달할 수 있으며, 둘 다 현재 워크스페이스의 엔터티 유형 설정에 기록됩니다.

호출 시 주의사항

OpenAPI는 더 이상 사용되지 않는 엔터티 유형 그룹 매개변수를 지원하지 않습니다.
최소 엔터티 유형만 생성하려면 entityType만 전달하면 됩니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"entityType":"custom_demo","name":"사용자 정의 유형","description":"데모 유형"}'

응답¶

{
    "code": 200,
    "content": {
        "uuid": "cate_xxxx",
        "entityType": "custom_demo",
        "name": "사용자 정의 유형",
        "sourceType": "custom",
        "extraConfig": {},
        "customProperties": "",
        "effectiveSchemaDefine": "yaml text"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}