API-guide för schematabell

Senaste uppdatering: 2023-08-25
  • Ämnen:
  • Schemas
    Visa mer om det här ämnet
  • Skapat för:
  • Developer
    User
    Admin
    Leader

Det här dokumentet innehåller ytterligare information om hur du arbetar med Schema Registry API.

Använda frågeparametrar

The Schema Registry har stöd för användning av frågeparametrar för att sidgranska och filtrera resultat när resurser listas.

OBSERVERA

När du kombinerar flera frågeparametrar måste de avgränsas med et-tecken (&).

Sidindelning

De vanligaste frågeparametrarna för sidindelning är:

Parameter Beskrivning
orderby Sortera resultat efter en specifik egenskap. Exempel: orderby=title sorterar resultaten efter rubrik i stigande ordning (A-Z). Lägga till en - före parametervärdet (orderby=-title) sorterar objekten efter rubrik i fallande ordning (Z-A).
limit Vid användning tillsammans med en orderby parameter, limit begränsar det maximala antalet objekt som ska returneras för en viss begäran. Den här parametern kan inte användas utan en orderby parameter finns.

The limit parameter anger ett positivt heltal (mellan 0 och 500) som tips om det maximala antalet artiklar som ska returneras. Till exempel: limit=5 returnerar bara fem resurser i listan. Detta värde respekteras dock inte. Den faktiska svarsstorleken kan vara mindre eller större, vilket begränsas av behovet av att tillhandahålla en tillförlitlig drift av start parameter, om en sådan har angetts.
start Vid användning tillsammans med en orderby parameter, start Anger var den undergrupperade listan med objekt ska börja. Den här parametern kan inte användas utan en orderby parameter finns. Det här värdet kan hämtas från _page.next attribut för ett listsvar och används för att komma åt nästa resultatsida. Om _page.next värdet är null, så det finns ingen ytterligare sida tillgänglig.

Normalt utelämnas den här parametern för att få fram den första resultatsidan. Efter det har start ska anges till det maximala värdet för den primära sorteringsegenskapen för orderby fält som tagits emot på föregående sida. API-svaret returnerar sedan poster som börjar med de som har en primär sorteringsegenskap från orderby strikt större än (för stigande) eller strikt mindre än (för fallande) det angivna värdet.

Om orderby parametern är inställd på orderby=name,firstname, start parametern skulle innehålla ett värde för name -egenskap. Om du i det här fallet vill visa de nästa 20 posterna för en resurs direkt efter namnet "Miller", använder du: ?orderby=name,firstname&start=Miller&limit=20.

Filtrering

Du kan filtrera resultaten med property parameter, som används för att tillämpa en viss operator på en viss JSON-egenskap i hämtade resurser. Operatorer som stöds är:

Operatör Beskrivning Exempel
== Filtrerar efter om egenskapen är lika med det angivna värdet. property=title==test
!= Filtrerar efter om egenskapen inte är lika med det angivna värdet. property=title!=test
< Filtrerar efter om egenskapen är mindre än det angivna värdet. property=version<5
> Filtrerar efter om egenskapen är större än det angivna värdet. property=version>5
<= Filtrerar efter om egenskapen är mindre än eller lika med det angivna värdet. property=version<=5
>= Filtrerar efter om egenskapen är större än eller lika med det angivna värdet. property=version>=5
(Ingen) Om du bara anger egenskapsnamnet returneras bara poster där egenskapen finns. property=title
TIPS

Du kan använda property parameter för att filtrera schemafältgrupper efter deras kompatibla klass. Till exempel: property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile returnerar endast fältgrupper som är kompatibla med XDM Individual Profile klassen.

Kompatibilitetsläge

Experience Data Model (XDM) är en öppet dokumenterad specifikation som drivs av Adobe för att förbättra interoperabiliteten, uttrycksfullheten och styrkan i digitala upplevelser. Adobe underhåller källkoden och de formella XDM-definitionerna i en öppen källkodsprojekt på GitHub. Dessa definitioner är skrivna i XDM Standard Notation, med JSON-LD (JavaScript Object Notation for Linked Data) och JSON Schema som grammatik för att definiera XDM-scheman.

När du tittar på formella XDM-definitioner i den offentliga databasen ser du att standard-XDM skiljer sig från det du ser i Adobe Experience Platform. Vad du ser i Experience Platform kallas Kompatibilitetsläge och ger en enkel mappning mellan standard-XDM och det sätt som det används i Platform.

Så här fungerar kompatibilitetsläget

Kompatibilitetsläge gör att XDM JSON-LD-modellen kan arbeta med befintlig datainfrastruktur genom att ändra värden inom standard-XDM samtidigt som semantiken förblir densamma. Den använder en kapslad JSON-struktur och visar scheman i ett trädliknande format.

Den största skillnaden mellan standard-XDM och kompatibilitetsläge är borttagningen av "xdm:"-prefixet för fältnamn.

Följande är en jämförelse sida vid sida som visar födelsedagsrelaterade fält (där attributen "description" har tagits bort) i både standard-XDM och kompatibilitetsläge. Observera att fälten för kompatibilitetsläge innehåller en referens till XDM-fältet och dess datatyp i attributen "meta:xdmField" och "meta:xdmType".

Standard XDM Kompatibilitetsläge
{ "xdm:BirthDate": { "title": "Birth Date", "type": "string", "format": "date" }, "xdm:BirthDayAndMonth": { "title": "Birth Date", "type": "string", "pattern": "[0-1][0-9]-[0-9][0-9][0-9]" }, "xdm:bornYear": { "title": "Birth year", "type": "integer", "minimum": 1, "maximum": 32767 } }
  
{ "BirthDate": { "title": "Birth Date", "type": "string", "format": "date", "meta:xdmField": "xdm:bornDate", "meta:xdmType": "date" }, "BirthDayAndMonth": { "title", "type": "string", "pattern": "[0-1][0-9]-[0-9][0-9]", "meta:xdmField": "xdm:bornDayAndMonth", "meta:xdmType": "string" }, "BirthYear": "Birth year", "type": "integer", "minimum": 1, "maximum": 32767, "meta:xdmField": "xdm:bornYear", "meta:xdmType": "short" } }
      

Varför krävs kompatibilitetsläge?

Adobe Experience Platform är utformat för att fungera tillsammans med flera lösningar och tjänster, var och en med sina egna tekniska utmaningar och begränsningar (till exempel hur vissa tekniker hanterar specialtecken). Kompatibilitetsläge har utvecklats för att övervinna dessa begränsningar.

Mest Experience Platform tjänster, inklusive Catalog, Data Lakeoch Real-Time Customer Profile use Compatibility Mode i stället för standard XDM. The Schema Registry API använder också Compatibility Mode, och exemplen i det här dokumentet visas med Compatibility Mode.

Det är värt att veta att en mappning görs mellan standard-XDM och hur den används i Experience Platform, men det bör inte påverka din användning av Platform tjänster.

Open Source-projektet är tillgängligt för dig, men när det gäller att interagera med resurser via Schema Registryinnehåller API-exemplen i det här dokumentet de bästa metoder som du bör känna till och följa.

På denna sida