Unified Catalog Entity Type List¶

POST /api/v1/unified_catalog/entity_type_cfg/list

Overview¶

Retrieve the list of unified catalog entity types.

Body Request Parameters¶

Parameter Name	Type	Description
pageIndex	integer	Page number, default 1 Nullable: False Example: 1 $minValue: 1
pageSize	integer	Number per page, default 20, max 200 Nullable: False Example: 20 $minValue: 1 $maxValue: 200
search	string	Search by entity type code or display name Nullable: False
filters	json	Filter entity types by matching entities via entity attributes Nullable: False
withDefault	boolean	Whether to include system default entity types, default true Nullable: False
withEntityCount	boolean	Whether to return entity count, default true Nullable: False

Additional Parameter Notes¶

Request Parameter Description

Parameter Name	Type	Required	Description
pageIndex	integer	No	Page number, default `1`
pageSize	integer	No	Number 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 entity count, default `true`

Notes

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

Request Example¶

curl 'https://openapi.truewatch.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": "Service",
                "sourceType": "default",
                "extraConfig": {},
                "entityCount": 12
            },
            {
                "uuid": "cate_xxxx",
                "entityType": "custom_demo",
                "name": "Custom Type",
                "sourceType": "custom",
                "extraConfig": {},
                "entityCount": 0
            }
        ],
        "pagination": {
            "pageIndex": 1,
            "pageSize": 20,
            "count": 2,
            "totalCount": 2
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}