Show Menu
THEMEN×

Listen

Sie können eine Liste aller Schema Registry-Ressourcen eines bestimmten Typs (Klassen, Mixins, Schema, Datentypen oder Deskriptoren) in einem Container durch eine GET-Anforderung erstellen.
Bei der Auflistung von Ressourcen wird das Schema Registry-Ergebnis auf 300 Elemente begrenzt. Um Ressourcen über diese Grenze hinaus zurückzugeben, müssen Sie Seitenparameter verwenden. Es wird außerdem empfohlen, Abfrage-Parameter zum Filtern der Ergebnisse und zur Reduzierung der zurückgegebenen Ressourcen zu verwenden.
API-Format
GET /{CONTAINER_ID}/{RESOURCE_TYPE}
GET /{CONTAINER_ID}/{RESOURCE_TYPE}?{QUERY_PARAMS}

Parameter
Beschreibung
{CONTAINER_ID}
Der Container, in dem sich die Ressourcen befinden ("global"oder "mieter").
{RESOURCE_TYPE}
Der Typ der Ressource, die aus der Schema-Bibliothek abgerufen werden soll. Gültige Typen sind classes , mixins , schemas , datatypes und descriptors .
{QUERY_PARAMS }
Optionale Abfrage-Parameter zum Filtern der Ergebnisse. Weitere Informationen finden Sie im Abschnitt zu den Parametern für die Abfrage .
Anfrage
curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes&limit=2 \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Das Antwortformat hängt vom Accept-Header ab, der in der Anforderung gesendet wird. Die folgenden Accept-Header stehen zur Auflistung von Ressourcen zur Verfügung:
Kopfzeile akzeptieren
Beschreibung
application/vnd.adobe.xed-id+json
Gibt eine kurze Zusammenfassung der einzelnen Ressourcen zurück. Dies ist die empfohlene Kopfzeile für die Auflistung der Ressourcen. (Maximal: 300)
application/vnd.adobe.xed+json
Gibt das vollständige JSON-Schema für jede Ressource zurück, wobei das Original $ref und allOf die Variable enthalten sind. (Maximal: 300)
application/vnd.adobe.xdm-v2+json
Bei Verwendung des /descriptors Endpunkts muss dieser Accept-Header verwendet werden, um Paging-Funktionen zu nutzen.
Antwort
In der obigen Anforderung wurde der Header application/vnd.adobe.xed-id+json "Akzeptieren"verwendet. Daher enthält die Antwort nur die Attribute title , $id , meta:altId und version für jede Ressource. Wenn Sie full in den Accept-Header wechseln, werden alle Attribute jeder Ressource zurückgegeben. Wählen Sie den entsprechenden Accept-Header je nach den Informationen, die Sie in Ihrer Antwort benötigen.
{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

Verwenden von Abfrage-Parametern

Die Schema Registry unterstützt die Verwendung von Abfrage-Parametern zum Anzeigen von und Filtern von Ergebnissen bei der Auflistung von Ressourcen.
Bei der Kombination mehrerer Parameter für die Abfrage müssen diese durch das kaufmännische Und ( & ) getrennt werden.

Paging

Zu den gebräuchlichsten Parametern für die Abfrage von Paging gehören:
Parameter
Beschreibung
start
Geben Sie an, wo die aufgelisteten Ergebnisse beginnen sollen. Dieser Wert kann aus dem _page.next Attribut einer Liste-Antwort abgerufen und für den Zugriff auf die nächste Ergebnisseite verwendet werden. Wenn der _page.next Wert null ist, ist keine zusätzliche Seite verfügbar.
limit
Schränken Sie die Anzahl der zurückgegebenen Ressourcen ein. Beispiel: limit=5 gibt eine Liste von fünf Ressourcen zurück.
orderby
Sortieren Sie die Ergebnisse nach einer bestimmten Eigenschaft. Beispiel: orderby=title sortiert die Ergebnisse nach Titel in aufsteigender Reihenfolge (A-Z). Durch Hinzufügen eines - Vor-Titels ( orderby=-title ) werden Elemente in absteigender Reihenfolge nach Titel sortiert (Z-A).

Filter

Sie können die Ergebnisse mithilfe des property Parameters filtern, der verwendet wird, um einen bestimmten Operator auf eine bestimmte JSON-Eigenschaft in den abgerufenen Ressourcen anzuwenden. Zu den unterstützten Operatoren gehören:
Operator
Beschreibung
Beispiel
==
Filter, ob die Eigenschaft dem bereitgestellten Wert entspricht.
property=title==test
!=
Filter, ob die Eigenschaft nicht mit dem bereitgestellten Wert übereinstimmt.
property=title!=test
<
Filter, ob die Eigenschaft kleiner als der angegebene Wert ist.
property=version<5
>
Filter, ob die Eigenschaft größer als der angegebene Wert ist.
property=version>5
<=
Filter, ob die Eigenschaft kleiner als oder gleich dem bereitgestellten Wert ist.
property=version<=5
>=
Filter, ob die Eigenschaft größer oder gleich dem bereitgestellten Wert ist.
property=version>=5
~
Filter, ob die Eigenschaft mit einem bereitgestellten regulären Ausdruck übereinstimmt.
property=title~test$
(Keine)
Wenn nur der Eigenschaftsname angegeben wird, werden nur Einträge zurückgegeben, bei denen die Eigenschaft vorhanden ist.
property=title
Sie können den property Parameter verwenden, um Mixins nach ihrer kompatiblen Klasse zu filtern. Gibt beispielsweise property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile nur Mixins zurück, die mit der XDM Individual Profil-Klasse kompatibel sind.