È possibile recuperare un elenco di tutti gli oggetti disponibili di un tipo specifico tramite una singola chiamata API; la best practice prevede l’inclusione di filtri che limitano la dimensione della risposta.
Formato API
GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
Parametro | Descrizione |
---|---|
{OBJECT_TYPE} |
Il tipo di Catalog oggetto da elencare. Gli oggetti validi sono:
|
{FILTER} |
Parametro di query utilizzato per filtrare i risultati restituiti nella risposta. Più parametri separati da e commerciali (& ). Consulta la guida su filtraggio dei dati catalogo per ulteriori informazioni. |
Richiesta
La richiesta di esempio seguente recupera un elenco di set di dati con limit
filtro che riduce la risposta a cinque risultati, e una properties
filtro che limita le proprietà visualizzate per ogni set di dati.
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}'
Risposta
In caso di esito positivo, la risposta restituisce un elenco di Catalog oggetti sotto forma di coppie chiave-valore, filtrati in base ai parametri di query forniti nella richiesta. Per ogni coppia chiave-valore, la chiave rappresenta un identificatore univoco per Catalog oggetto in questione, che può quindi essere utilizzato in un'altra chiamata a visualizzare l'oggetto specifico per ulteriori dettagli.
Se un oggetto restituito non contiene una o più delle proprietà richieste indicate dal properties
, la risposta restituisce solo le proprietà richieste che include, come mostrato nella Sample Dataset 3
e Sample Dataset 4
di seguito.
{
"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"
}
}