查找多個目錄對象

如果您想要檢視數個特定物件,而不是對每個物件提出一個要求, Catalog 提供了一個簡單快捷方式,用於請求同一類型的多個對象。 您可以加入以逗號分隔的ID清單,以使用單一GET請求傳回多個特定物件。

注意

即使請求特定 Catalog 對象,仍然是 properties 查詢參數,僅傳回您需要的屬性。

API格式

GET /{OBJECT_TYPE}/{ID_1},{ID_2},{ID_3},{ID_4}
GET /{OBJECT_TYPE}/{ID_1},{ID_2},{ID_3},{ID_4}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
參數 說明
{OBJECT_TYPE} 類型 Catalog 要擷取的物件。 有效對象包括:
  • accounts
  • batches
  • connections
  • connectors
  • dataSets
  • dataSetFiles
  • dataSetViews
{ID} 要檢索的特定對象之一的標識符。

要求

下列請求包含以逗號分隔的資料集ID清單,以及要針對每個資料集傳回的逗號分隔屬性清單。

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5bde21511dd27b0000d24e95,5bda3a4228babc0000126377,5bceaa4c26c115000039b24b,5bb276b03a14440000971552,5ba9452f7de80400007fc52a?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}'

回應

成功的回應會傳回指定資料集的清單,僅包含請求的屬性(name, description,和 files)。

注意

如果傳回的物件不包含由 properties 查詢時,回應只會傳回其所包含的請求屬性,如 Sample Dataset 3Sample 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"
    }
}

本頁內容