Unified Catalog Entity Type List¶

POST /api/v1/unified_catalog/entity_type_cfg/list

Overview¶

Get the unified catalog entity type list.

Body Request Parameters¶

Parameter Name	Type	Description
pageIndex	integer	Page number, default 1 Nullable: False Example: 1 $minValue: 1
pageSize	integer	Items per page, default 20, maximum 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 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

Parameter Supplementary Description¶

Request Parameter Description

Parameter Name	type	Required	Description
pageIndex	integer	No	Page number, default `1`
pageSize	integer	No	Items per page, default `20`
search	string	No	Search by entity type code or display name
filters	json	No	Filter by entity `attributes` to inversely filter entity types
withDefault	boolean	No	Whether to include system default types, default `true`
withEntityCount	boolean	No	Whether to return entity count, default `true`

Call Notes

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

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": {}
            },
            {
                "uuid": "cate_xxxx",
                "entityType": "custom_demo",
                "name": "Custom Type",
                "sourceType": "custom",
                "extraConfig": {}
            }
        ],
        "pagination": {
            "pageIndex": 1,
            "pageSize": 20,
            "count": 2,
            "totalCount": 2
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}