查詢目錄物件

如果您知道特定Catalog物件的唯一識別碼,則可以執行GET要求來檢視該物件的詳細資訊。

NOTE
檢視特定物件時,最佳實務仍是依屬性篩選,並只傳回您感興趣的屬性。

API格式

GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
參數
說明
{OBJECT_TYPE}

要擷取的Catalog物件型別。 有效的物件包括:

  • batches
  • dataSets
  • dataSetFiles
{OBJECT_ID}
您要擷取之特定物件的識別碼。

要求

下列要求會依其ID擷取資料集,傳回其namedescriptiontagsfiles屬性。

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": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    }
}
NOTE
值以@為前置詞的屬性代表相互關聯的物件。 如需如何檢視這些物件詳細資訊的步驟,請參閱檢視相關物件的附錄一節。
recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676