Katalogobjekte auflisten

Sie können über einen einzigen API-Aufruf eine Liste aller verfügbaren Objekte eines bestimmten Typs abrufen. Es empfiehlt sich, Filter einzubeziehen, um die Größe der Antwort beschränken.

API-Format

GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
Parameter Beschreibung
{OBJECT_TYPE} Der Typ von Catalog -Objekt, das aufgeführt werden soll. Gültige Objekte sind:
  • accounts
  • batches
  • connections
  • connectors
  • dataSets
  • dataSetFiles
  • dataSetViews
{FILTER} Ein Abfrageparameter, mit dem die in der Antwort zurückgegebenen Ergebnisse gefiltert werden. Mehrere Parameter werden durch das kaufmännische Und-Zeichen (&) getrennt. Weiterführende Informationen finden Sie im Handbuch zum Filtern von Katalogdaten.

Anfrage

Die unten stehende Musteranfrage ruft eine Liste von Datensätzen ab, mit einem limit-Filter, der die Antwort auf fünf Ergebnisse reduziert, und einem properties-Filter, der die für die einzelnen Datensätze angezeigten Eigenschaften begrenzt.

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

Antwort

Eine erfolgreiche Antwort gibt eine Liste von Catalog -Objekte in Form von Schlüssel-Wert-Paaren, gefiltert durch die in der Anfrage angegebenen Abfrageparameter. Für jedes Schlüssel-Wert-Paar stellt der Schlüssel eine eindeutige Kennung für die Catalog -Objekt, das dann in einem anderen Aufruf an verwendet werden kann Anzeigen eines bestimmten Objekts für weitere Details.

HINWEIS

Wenn ein zurückgegebenes Objekt keine der angeforderten Eigenschaften enthält, die durch die Variable properties -Abfrage, gibt die Antwort nur die angeforderten Eigenschaften zurück, die sie enthält, wie in Sample Dataset 3 und Sample Dataset 4 unten.

{
    "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"
    }
}

Auf dieser Seite