DokumentationExperience PlatformAnvändarhandbok om kataloger och datauppsättningar

Lista katalogobjekt

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

Skapat för:

  • Utvecklare

Du kan hämta en lista över alla tillgängliga objekt av en viss typ via ett enda API-anrop. Det bästa sättet är att ta med filter som begränsar svarsstorleken.

API-format

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

Den typ av Catalog-objekt som ska listas. Giltiga objekt är:

  • batches
  • dataSets
  • dataSetFiles
{FILTER}
En frågeparameter som används för att filtrera resultaten som returneras i svaret. Flera parametrar avgränsas med et-tecken (&). Mer information finns i guiden Filtrera katalogdata.

Begäran

Exempelbegäran nedan hämtar en lista med datauppsättningar, med ett limit-filter som reducerar svaret till fem resultat, och ett properties-filter som begränsar vilka egenskaper som visas för varje datauppsättning.

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}'

Svar

Ett godkänt svar returnerar en lista med Catalog objekt i form av nyckelvärdepar, filtrerade med frågeparametrarna som anges i begäran. För varje nyckelvärdepar representerar nyckeln en unik identifierare för det aktuella Catalog-objektet, som sedan kan användas i ett annat anrop för att visa det specifika objektet för mer information.

NOTE
Om ett returnerat objekt inte innehåller en eller flera av de begärda egenskaperna som anges av properties-frågan, returnerar svaret endast de begärda egenskaper som det innehåller, vilket visas i Sample Dataset 3 och Sample Dataset 4 nedan.
{
    "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