コンテンツにスキップ

統合カタログエンティティタイプ詳細¶

GET /api/v1/unified_catalog/entity_type_cfg/get

概要¶

単一の統合カタログエンティティタイプの詳細を取得します。

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

パラメータ名	タイプ	必須	説明
entityTypeUUID	string		エンティティタイプ UUID；`default` を指定した場合はカスタムエンティティタイプ作成テンプレートを返します。空を許可: False
entityType	string		エンティティタイプコード空を許可: False

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
entityTypeUUID	string	いいえ	エンティティタイプ UUID
entityType	string	いいえ	エンティティタイプコード

呼び出し時の注意事項

entityTypeUUID と entityType のうち、少なくとも1つを指定してください。
entityTypeUUID=default を指定した場合、カスタムエンティティタイプ作成テンプレートを返します。このテンプレートは status=3 のデータであり、エンティティタイプ一覧には表示されません。
両方のパラメータを指定する場合は、同じエンティティタイプを指すことを推奨します。
レスポンスには schemaDefine、viewDefine、extraConfig が含まれます。
現在のワークスペースの customProperties と、マージ後の effectiveSchemaDefine を返します。
OpenAPI 互換性維持のため、一覧と詳細ではデフォルトで entityCount をクエリし、返却します。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/get?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

レスポンス¶

{
    "code": 200,
    "content": {
        "uuid": "sys_service",
        "entityType": "service",
        "name": "サービス",
        "schemaDefine": "yaml テキスト",
        "viewDefine": "yaml テキスト",
        "extraConfig": {},
        "customProperties": "custom_properties:\\n  - name: business_owner\\n    type: string\\n",
        "effectiveSchemaDefine": "yaml テキスト",
        "entityCount": 12
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}