メタデータの取得
Customer Data Platform のメタデータ API の応答には、すべてのエンティティに関するメタデータが含まれます。これには、計算済みインサイト、エンゲージメント、プロファイルなどのエンティティのほか、メタデータと他のオブジェクトのリレーションも含まれます。
GET /api/v1/metadata
計算済みインサイト、エンゲージメント、プロファイル、その他のオブジェクトのメタデータを返します。
構文
- HTTP のメソッド
- GET
- 使用可能なバージョン
- Customer Data Platform v1.0、Salesforce API バージョン 51.0 以降
- 形式
- REST
- URI
- /api/v1/metadata/
要求パラメータ
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| entityType | string | 要求されたメタデータエンティティの種別。デフォルトでは、このパラメータには使用可能なすべての種別が含まれます。使用できる値: DataLakeObject、DataModelObject、CalculatedInsight |
| entityCategory | string | 要求されたメタデータエンティティのカテゴリ。デフォルトでは、このパラメータには使用可能なすべてのカテゴリが含まれます。計算済みインサイトエンティティには適用されません。使用できる値: プロファイル、エンゲージメント、関連 |
| entityName | string | 要求されたメタデータエンティティの名前。デフォルトでは、このパラメータにはエンティティの完全なリストの使用可能なすべてのカテゴリが含まれます。例: UnifiedIndividual__dlm |
例
- 要求
-
- 応答
-
HTTP 応答
| 応答 | 理由 |
|---|---|
| 200 OK | コールバックが正常に検証されました。 |
| 400 Bad Request | 無効な要求です。 |
| 500 Server Error | 内部エラーです。 |