Enumerar objetos de catálogo
Puede recuperar una lista de todos los objetos disponibles de un tipo específico mediante una sola llamada de API, siendo la práctica recomendada incluir filtros que limiten el tamaño de la respuesta.
Formato de API
GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
{OBJECT_TYPE}
El tipo de objeto Catalog que se va a enumerar. Los objetos válidos son:
batches
dataSets
dataSetFiles
{FILTER}
&
). Consulte la guía filtrado de datos de catálogo para obtener más información.Solicitud
La solicitud de ejemplo siguiente recupera una lista de conjuntos de datos, con un filtro limit
que reduce la respuesta a cinco resultados y un filtro properties
que limita las propiedades mostradas para cada conjunto de datos.
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}'
Respuesta
Una respuesta correcta devuelve una lista de Catalog objetos en forma de pares clave-valor, filtrados por los parámetros de consulta proporcionados en la solicitud. Para cada par clave-valor, la clave representa un identificador único para el objeto Catalog en cuestión, el cual puede usarse en otra llamada a vea ese objeto específico para obtener más detalles.
properties
, la respuesta devuelve únicamente las propiedades solicitadas que sí incluye, como se muestra en Sample Dataset 3
y Sample Dataset 4
a continuación.{
"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"
}
}