API-guide för schematabell

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

Använda frågeparametrar query

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

Sidindelning paging

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

Filtrering filtering

Du kan filtrera resultat med parametern property som används för att tillämpa en viss operator på en viss JSON-egenskap i de hämtade resurserna. Operatorer som stöds är:

Kompatibilitetsläge compatibility

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 ett öppen källkodsprojekt på GitHub. Dessa definitioner är skrivna i XDM Standard Notation, där JSON-LD (JavaScript Object Notation for Linked Data) och JSON Schema används 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. Det du ser i Experience Platform kallas Kompatibilitetsläge och ger en enkel mappning mellan standard-XDM och hur 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".

{
  "xdm:bornDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date"
  },
  "xdm:bornDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    "mönster": "[0-1][0-9]-[0-9][0-9]"
  },
  "xdm:bornYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767
  }
}

{
  "bornDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date",
    "meta:xdmField": "xdm:bornDate",
    "meta:xdmType": "date"
  },
  "bornDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    "pattern": "[0-1][0-9]-[0-9][0-9]",
    "meta:xdmField": "xdm:bornDayAndMonth",
    "meta:xdmType": "string"
  },
  "bornYear": {
    "title": "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.

De flesta Experience Platform-tjänster, inklusive Catalog, Data Lake och Real-Time Customer Profile använder Compatibility Mode i stället för standard-XDM. API:t Schema Registry använder också Compatibility Mode, och exemplen i det här dokumentet visas alla med Compatibility Mode.

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

Du har tillgång till projektet med öppen källkod, men när det gäller att interagera med resurser via Schema Registry innehåller API-exemplen i det här dokumentet de bästa metoder du bör känna till och följa.