콘텐츠로 이동

통합 카탈로그 엔터티 유형 상세¶

GET /api/v1/unified_catalog/entity_type_cfg/get

개요¶

단일 통합 카탈로그 엔터티 유형의 상세 정보를 조회합니다.

Query 요청 파라미터¶

파라미터명	유형	필수	설명
entityTypeUUID	string		엔터티 유형 UUID; default 전달 시 사용자 정의 엔터티 유형 생성 템플릿 반환 빈 값 허용 안 함: False
entityType	string		엔터티 유형 코드 빈 값 허용 안 함: False

파라미터 추가 설명¶

요청 파라미터 설명

파라미터명	type	필수	설명
entityTypeUUID	string	아니요	엔터티 유형 UUID
entityType	string	아니요	엔터티 유형 코드

호출 시 주의사항

entityTypeUUID와 entityType 중 최소 하나를 전달해야 합니다.
entityTypeUUID=default인 경우 사용자 정의 엔터티 유형 생성 템플릿이 반환됩니다. 이 템플릿은 status=3 데이터로, 엔터티 유형 목록에 표시되지 않습니다.
두 파라미터를 모두 전달할 경우, 동일한 엔터티 유형을 가리키도록 하는 것이 좋습니다.
응답 결과에는 schemaDefine, viewDefine, extraConfig가 포함됩니다.
현재 워크스페이스의 customProperties와 병합된 effectiveSchemaDefine이 반환됩니다.
OpenAPI 호환성 유지: 목록 및 상세 조회 시 기본적으로 entityCount를 포함하여 조회 및 반환합니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/get?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

응답¶

{
    "code": 200,
    "content": {
        "uuid": "sys_service",
        "entityType": "service",
        "name": "서비스",
        "schemaDefine": "yaml text",
        "viewDefine": "yaml text",
        "extraConfig": {},
        "customProperties": "custom_properties:\\n  - name: business_owner\\n    type: string\\n",
        "effectiveSchemaDefine": "yaml text",
        "entityCount": 12
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}