清單目錄對象

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

API格式

GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
參數 說明
{OBJECT_TYPE} 要列出的Catalog對象類型。 有效對象包括:
  • accounts
  • batches
  • connections
  • connectors
  • dataSets
  • dataSetFiles
  • dataSetViews
{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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的響應以鍵值對的形式返回Catalog對象的清單,該清單由請求中提供的查詢參數篩選。 對於每個鍵值對,鍵代表有關Catalog對象的唯一標識符,然後該標識符可用於對查看該特定對象的另一調用,以獲得更多詳細資訊。

注意

如果返回的對象不包含properties查詢所指示的一個或多個請求屬性,則響應僅返回其所包含的請求屬性,如下面的​***Sample Dataset 3​和​Sample Dataset 4***​所示。

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSets/5bb276b03a14440000971552/views/5bb276b01250b012f9acc75b/files"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSets/5bda3a4228babc0000126377/views/5bda3a4228babc0000126378/files"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSets/5bde21511dd27b0000d24e95/views/5bde21511dd27b0000d24e96/files"
    }
}

本頁內容

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free