特定の Catalog オブジェクトの場合は、GETリクエストを実行して、そのオブジェクトの詳細を表示できます。
特定のオブジェクトを表示する場合も、プロパティでフィルターし、目的のプロパティのみを返すのがベストプラクティスです。
API 形式
GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
パラメーター | 説明 |
---|---|
{OBJECT_TYPE} |
のタイプ Catalog 取得するオブジェクト。 有効なオブジェクトは次のとおりです。
|
{OBJECT_ID} |
取得する特定のオブジェクトの識別子。 |
リクエスト
次のリクエストでは、ID でデータセットを取得し、その ID を返します name
, description
, tags
、および files
プロパティ。
curl -X GET \
'https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a?properties=name,description,tags,files' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
正常な応答は、指定されたデータセッを返します。本文にはリクエストされた properties
のみが含まれます。
{
"5ba9452f7de80400007fc52a": {
"name": "Sample Dataset",
"description": "Sample dataset containing important data.",
"tags": {
"adobe/pqs/table": [
"sample_dataset"
]
},
"files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
}
}
値の前に @
が付いているプロパティは、相互に関連するオブジェクトを表します。これらのオブジェクトの詳細を表示する手順については、付録の「相互関連オブジェクトの表示」の節を参照してください。