コンテンツにスキップ

統合カタログエンティティタイプ作成¶

POST /api/v1/unified_catalog/entity_type_cfg/create

概要¶

統合カタログのエンティティタイプを作成します。

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

パラメータ名	タイプ	必須	説明
entityType	string	Y	エンティティタイプコード（グローバル一意）空を許可: False 最大長: 64
name	string		エンティティタイプ表示名空を許可: False 最大長: 128
description	string		エンティティタイプ説明空を許可: False 最大長: 512
extraConfig	json		現在のワークスペースにおけるエンティティタイプの追加設定空を許可: False
customProperties	string		現在のワークスペースでエンティティタイプに追加する DataSchema カスタムフィールドの YAML テキスト。トップレベルは `custom_properties` を推奨空を許可: False
schemaDefine	string		DataSchema YAML テキスト空を許可: False
viewDefine	string		UIView YAML テキスト空を許可: False
extend	json		拡張フィールド空を許可: False

パラメータ補足説明¶

リクエストパラメータ説明

パラメータ名	type	必須	説明
entityType	string	はい	エンティティタイプコード。グローバルに一意
name	string	いいえ	エンティティタイプ表示名
description	string	いいえ	エンティティタイプ説明
extraConfig	json	いいえ	現在のワークスペースにおける追加設定
healthConfig	json	いいえ	作成インターフェースではこのフィールドは処理しません。作成後はエンティティタイプ変更インターフェースで健全性を設定します
customProperties	string	いいえ	現在のワークスペースでエンティティタイプに追加する DataSchema カスタムフィールドの YAML テキスト。トップレベルは `custom_properties` を推奨
schemaDefine	string	いいえ	DataSchema YAML テキスト
viewDefine	string	いいえ	UIView YAML テキスト
extend	json	いいえ	拡張フィールド

テンプレート使用説明

schemaDefine または viewDefine が渡されない場合、システムはデフォルトテンプレートから自動的に補完します。
デフォルトテンプレート内の {entity_type} は、今回のリクエストの entityType に置き換えられます。
呼び出し元が完全にカスタマイズしたテンプレートを使用したい場合は、完全な YAML テキストを直接渡すことができます。
作成時に extraConfig と customProperties を同時に渡すことができ、これらは現在のワークスペースのエンティティタイプ設定に書き込まれます。

呼び出し時の注意事項

OpenAPI は廃止予定のエンティティタイプグループパラメータをサポートしていません。
最小限のエンティティタイプのみを作成したい場合は、entityType のみを渡すことができます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"entityType":"custom_demo","name":"カスタムタイプ","description":"demo type"}'

レスポンス¶

{
    "code": 200,
    "content": {
        "uuid": "cate_xxxx",
        "entityType": "custom_demo",
        "name": "カスタムタイプ",
        "sourceType": "custom",
        "extraConfig": {},
        "customProperties": "",
        "effectiveSchemaDefine": "yaml text"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}