列出目录对象

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

主题：

创建对象：

undefined

您可以通过单个API调用检索特定类型的所有可用对象列表，最佳做法是包含限制响应大小的过滤器。

API格式

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

参数

描述

{OBJECT_TYPE}

要列出的Catalog对象的类型。有效对象为：

batches
dataSets
dataSetFiles

{FILTER}

用于筛选响应中返回结果的查询参数。多个参数由&符号(&)分隔。有关详细信息，请参阅筛选目录数据指南。

请求

下面的示例请求检索数据集列表，使用limit筛选器减少对5个结果的响应，使用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