統合カタログエンティティエクスポート¶
GET /api/v1/unified_catalog/entity/export
概要¶
統合カタログのエンティティ一覧を CSV としてエクスポートします。エクスポート列はエンティティタイプのビュー定義 viewDefine.layout に従います。
Query リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| entityType | string | Y | エンティティタイプコード 空を許可: False |
| provider | string | 単一のソースタイプ。複数の値の場合は filters または providers の利用を推奨 空を許可: False |
|
| search | string | あいまい検索。urn / display_name / name にマッチ 空を許可: False |
|
| filters | json | attributes フィールドのフィルター。JSON オブジェクトまたは文字列化された JSON に対応 空を許可: False 例: {'env': ['prod']} |
|
| orderBy | string | ソートフィールド。デフォルトは updatedAt 空を許可: False |
|
| order | string | ソート方向。デフォルトは desc 空を許可: False |
パラメーター補足説明¶
リクエストパラメーターの説明
| パラメーター名 | type | 必須 | 説明 |
|---|---|---|---|
| entityType | string | はい | エンティティタイプコード。タイプごとにエクスポート列が異なります |
| provider | string | いいえ | 単一のソースタイプ |
| search | string | いいえ | あいまい検索。urn / display_name / name にマッチ |
| filters | json | いいえ | attributes フィールドのフィルター |
| orderBy | string | いいえ | ソートフィールド。デフォルトは updatedAt |
| order | string | いいえ | ソート方向。デフォルトは desc |
呼び出し時の注意事項
- エクスポート列はエンティティタイプのビュー定義
viewDefine.layoutに従います。 filtersは JSON オブジェクトまたは文字列化された JSON に対応します。- 成功すると、API は CSV ファイルのストリームを直接返します。呼び出し側はファイルダウンロード方式で処理することを推奨します。
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/export?entityType=database&filters={"env":["prod"]}' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--output entities.csv