列出目錄物件

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
目錄

建立對象：

開發人員

您可以透過單一API呼叫來擷取特定型別的所有可用物件清單，最佳實務是加入可限制回應大小的篩選器。

API格式

GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}

參數

說明

{OBJECT_TYPE}

要列出的Catalog物件型別。有效的物件包括：

batches
dataSets
dataSetFiles

{FILTER}

用來篩選回應中傳回結果的查詢引數。多個引數以&符號(&)分隔。如需詳細資訊，請參閱篩選目錄資料的指南。

要求

下列範例要求會擷取資料集清單，limit篩選會將回應減少為五個結果，以及properties篩選會限制每個資料集所顯示的屬性。

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?limit=5&properties=name,description,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}'

回應

成功的回應會以索引鍵值配對的形式傳回Catalog物件清單，並根據要求中提供的查詢引數加以篩選。對於每個索引鍵/值組，索引鍵代表相關Catalog物件的唯一識別碼，然後可用於對檢視特定物件的其他呼叫以取得詳細資訊。

NOTE

如果傳回的物件不包含properties查詢所指示的一或多個要求屬性，則回應只會傳回其包含的要求屬性，如下方***Sample Dataset 3和Sample Dataset 4***所示。

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bb276b03a14440000971552"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSetFiles?dataSetId=5bda3a4228babc0000126377"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bde21511dd27b0000d24e95"
    }
}

recommendation-more-help

c5c02be6-79a3-4a2f-b766-136bffe8b676