Skip to content

Unified Catalog Entity Type List¶

POST /api/v1/unified_catalog/entity_type_cfg/list

Overview¶

Retrieve the list of entity types in the Unified Catalog.

Body Request Parameters¶

Parameter Name	Type	Required	Description
pageIndex	integer		Page index, default `1` Nullable: No Example: `1` $minValue: 1
pageSize	integer		Number of items per page, default `20`, max `200` Nullable: No Example: `20` $minValue: 1 $maxValue: 200
search	string		Search by entity type code or display name Nullable: No
filters	json		Filter entity types by matching entity attributes Nullable: No
withDefault	boolean		Whether to include system default entity types, default `true` Nullable: No
withEntityCount	boolean		Whether to return the entity count, default `true` Nullable: No
summaryOnly	boolean		Whether to return a lightweight summary; when `true`, `schemaDefine`, `viewDefine`, `fieldMetadata`, and `effective` definitions are not read or returned Nullable: No

Parameter Details¶

Request Parameter Description

Parameter Name	Type	Required	Description
pageIndex	integer	No	Page index, default `1`
pageSize	integer	No	Number of items per page, default `20`
search	string	No	Search by entity type code or display name
filters	json	No	Filter entity types by entity `attributes`
withDefault	boolean	No	Whether to include system default types, default `true`
withEntityCount	boolean	No	Whether to return the entity count, default `true`
summaryOnly	boolean	No	Whether to return a lightweight summary; when `true`, schema/view/effective definitions are not read or returned

Call Notes

This is a paginated API. It is recommended to explicitly pass pageIndex and pageSize.
The extraConfig in the response is the entity type extra configuration from the perspective of the current workspace.
Both default and custom types appear in the results, depending on the withDefault parameter.

Request Example¶

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}'

Response¶

{
    "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"
}