콘텐츠로 이동

통합 카탈로그 엔터티 유형 목록¶

POST /api/v1/unified_catalog/entity_type_cfg/list

개요¶

통합 카탈로그 엔터티 유형 목록을 조회합니다.

Body 요청 파라미터¶

파라미터명	타입	필수	설명
pageIndex	integer		페이지 번호, 기본값 1 빈 값 허용: False 예시: 1 $minValue: 1
pageSize	integer		페이지당 항목 수, 기본값 20, 최대 200 빈 값 허용: False 예시: 20 $minValue: 1 $maxValue: 200
search	string		엔터티 유형 코드 또는 표시명으로 검색 빈 값 허용: False
filters	json		엔터티 attributes를 통해 엔터티를 찾은 후 역방향으로 엔터티 유형 필터링 빈 값 허용: False
withDefault	boolean		시스템 기본 엔터티 유형 포함 여부, 기본값 true 빈 값 허용: False
withEntityCount	boolean		엔터티 수 반환 여부, 기본값 true 빈 값 허용: False
summaryOnly	boolean		경량 요약 반환 여부; true 시 schemaDefine, viewDefine, fieldMetadata 및 effective 정의를 읽거나 반환하지 않음 빈 값 허용: False

파라미터 보충 설명¶

요청 파라미터 설명

파라미터명	type	필수	설명
pageIndex	integer	아니요	페이지 번호, 기본값 `1`
pageSize	integer	아니요	페이지당 항목 수, 기본값 `20`
search	string	아니요	엔터티 유형 코드 또는 표시명으로 검색
filters	json	아니요	엔터티 `attributes`를 통해 필터링하여 역방향으로 엔터티 유형 선별
withDefault	boolean	아니요	시스템 기본 유형 포함 여부, 기본값 `true`
withEntityCount	boolean	아니요	엔터티 수 반환 여부, 기본값 `true`
summaryOnly	boolean	아니요	경량 요약 반환 여부; `true` 시 schema/view/effective 정의를 읽거나 반환하지 않음

호출 시 주의사항

페이지네이션 인터페이스이므로 pageIndex와 pageSize를 명시적으로 전달하는 것이 좋습니다.
응답 결과의 extraConfig는 현재 워크스페이스 관점에서의 엔터티 유형 추가 설정입니다.
기본 유형과 사용자 정의 유형이 결과에 함께 표시되며, withDefault 값에 따라 달라집니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"pageIndex":1,"pageSize":20,"withDefault":true,"withEntityCount":true}'

응답¶

{
    "code": 200,
    "content": {
        "items": [
            {
                "uuid": "sys_service",
                "entityType": "service",
                "name": "서비스",
                "sourceType": "default",
                "extraConfig": {},
                "entityCount": 12
            },
            {
                "uuid": "cate_xxxx",
                "entityType": "custom_demo",
                "name": "사용자 정의 유형",
                "sourceType": "custom",
                "extraConfig": {},
                "entityCount": 0
            }
        ],
        "pagination": {
            "pageIndex": 1,
            "pageSize": 20,
            "count": 2,
            "totalCount": 2
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}