コンテンツにスキップ

統合カタログエンティティタイプリスト¶

POST /api/v1/unified_catalog/entity_type_cfg/list

概要¶

統合カタログのエンティティタイプリストを取得します。

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
pageIndex	integer		ページ番号、デフォルト 1 空を許可: False 例: 1 $minValue: 1
pageSize	integer		1ページあたりの件数、デフォルト 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	いいえ	1ページあたりの件数、デフォルト `20`
search	string	いいえ	エンティティタイプコードまたは表示名で検索
filters	json	いいえ	エンティティの `attributes` でフィルタリングし、エンティティタイプを逆引きで絞り込み
withDefault	boolean	いいえ	システムデフォルトタイプを含めるかどうか、デフォルト `true`
withEntityCount	boolean	いいえ	エンティティ数を返すかどうか、デフォルト `true`
summaryOnly	boolean	いいえ	軽量サマリーのみを返すかどうか；`true` の場合、schema/view/effective 定義は読み取りまたは返却されません

呼び出し時の注意事項

このAPIはページネーション対応のため、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"
}