Lägga till specifika fält i ett schema med API:t för schemaregister

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

XDM-scheman (Experience Data Model) består av en basklass, där ytterligare fält inkluderas genom användning av standardfältgrupper som definieras av Adobe och anpassade fältgrupper som definieras av organisationen.

När du skapar ett schema kanske du vill använda vissa fält från en viss fältgrupp och utesluta andra från samma grupp som du inte behöver. I den här självstudien visas hur du lägger till enskilda fält från en fältgrupp i ett schema med API:t för schemaregister.

OBSERVERA

Information om hur du lägger till och tar bort enskilda schemafält i Adobe Experience Platform-gränssnittet finns i handboken fältbaserade arbetsflöden (för närvarande i betaversion).

Förutsättningar

Den här självstudiekursen handlar om att ringa API för schemaregister. Innan du börjar bör du granska utvecklarhandbok för viktig information som du behöver känna till för att kunna anropa API:t, inklusive {TENANT_ID}, konceptet med behållare och de huvuden som behövs för att göra förfrågningar.

Förstå meta:refProperty fält

För ett givet schema refereras den klass och fältgrupper som utgör dess struktur under dess allOf array. Varje komponent representeras som ett objekt som innehåller en $ref egenskap som refererar till komponentens URI $id.

Följande JSON representerar ett förenklat schema som använder en enda klass (experienceevent) och fältgrupp (experienceevent-all):

{
  "title": "My Sample Schema",
  "description": "My Sample Description",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all"
    }
  ]
}

För alla objekt i allOf array som refererar till en fältgrupp, du kan lägga till en jämställd meta:refProperty för att ange vilka fält i gruppen som ska inkluderas i schemat.

OBSERVERA

Varje fält anges med en JSON-pekarsträng, som representerar sökvägen till fältet i dess respektive fältgrupp. Strängen måste börja med ett inledande snedstreck (/) och ska inte innehålla några properties namnutrymmen. Exempel: /_experience/campaign/message/id.

När det ingår som en sträng, meta:refProperty kan referera till ett enskilt fält i en grupp. Andra fält från samma grupp kan inkluderas med samma $ref värde i ett annat objekt med ett annat meta:refProperty värde.

{
  "title": "My Sample Schema",
  "description": "An example schema that uses the XDM ExperienceEvent class.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": "/_experience/campaign/message/id"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": "/_experience/campaign/message/size"
    }
  ]
}

Alternativt kan meta:refProperty kan anges som en array, så att du kan ange flera fält som ska inkluderas från en viss grupp i en enda allOf listobjekt:

{
  "title": "My Sample Schema",
  "description": "An example schema that uses the XDM ExperienceEvent class.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": [
        "/_experience/campaign/message/id",
        "/_experience/campaign/message/size",
        "/_experience/campaign/message/variant"
      ]
    }
  ]
}

Lägga till fält med en PUT-åtgärd

Du kan använda en PUT-begäran för att skriva om ett helt schema och konfigurera fälten som du vill inkludera under allOf.

API-format

PUT /tenant/schemas/{SCHEMA_ID}
Parameter Beskrivning
{SCHEMA_ID} The meta:altId eller URL-kodad $id för schemat som du vill skriva om.

Begäran

Följande begäran uppdaterar de specifika fälten som ingår i fältgruppen under allOf array.

curl -X PUT \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67 \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
        "title": "My Sample Schema",
        "description": "My Sample Description",
        "type": "object",
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
          },
          {
            "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
            "meta:refProperty": [
              "/_experience/campaign/message/id",
              "/_experience/campaign/message/size",
              "/_experience/campaign/message/variant"
            ]
          }
        ]
      }'

Svar

Ett lyckat svar returnerar information om det uppdaterade schemat.

{
  "title": "My Sample Schema",
  "description": "My Sample Description",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": [
        "/_experience/campaign/message/id",
        "/_experience/campaign/message/size",
        "/_experience/campaign/message/variant"
      ]
    }
  ],
  "meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
  "meta:abstract": false,
  "meta:extensible": false,
  "meta:extends": [
      "https://ns.adobe.com/xdm/context/experienceevent",
      "https://ns.adobe.com/xdm/data/time-series"
  ],
  "meta:containerId": "tenant",
  "imsOrg": "{ORG_ID}",
  "meta:altId": "_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67",
  "meta:xdmType": "object",
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d5cc04eb8d50190001287e4c869ebe67",
  "version": "1.0",
  "meta:resourceType": "schemas",
  "meta:registryMetadata": {
      "repo:createDate": 1552088461236,
      "repo:lastModifiedDate": 1552088470592,
      "xdm:createdClientId": "{CREATED_CLIENT}",
      "xdm:repositoryCreatedBy": "{CREATED_BY}"
  }
}
OBSERVERA

Mer detaljerad information om PUT begär scheman finns i slutpunktshandbok för scheman.

Lägga till fält med en PATCH-åtgärd

Du kan använda en PATCH-begäran för att lägga till enskilda fält i ett schema utan att skriva över andra. Schemaregistret stöder alla JSON-korrigeringsåtgärder, inklusive add, removeoch replace. Mer information om JSON Patch finns i Grundläggande API-guide.

API-format

PATCH /tenant/schemas/{SCHEMA_ID}
Parameter Beskrivning
{SCHEMA_ID} The meta:altId eller URL-kodad $id för schemat som du vill skriva om.

Begäran

Följande begäran lägger till ett nytt objekt i schemats allOf array, ange fält som ska läggas till.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67 \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '[
        {
          "op": "add",
          "path": "/allOf/-",
          "value":  {
            "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
            "meta:refProperty": [
              "/_experience/campaign/message/id",
              "/_experience/campaign/message/size",
              "/_experience/campaign/message/variant"
            ]
          }
        }
      ]'

Svar

Ett lyckat svar returnerar information om det uppdaterade schemat.

{
  "title": "My Sample Schema",
  "description": "My Sample Description",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": [
        "/_experience/campaign/message/id",
        "/_experience/campaign/message/size",
        "/_experience/campaign/message/variant"
      ]
    }
  ],
  "meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
  "meta:abstract": false,
  "meta:extensible": false,
  "meta:extends": [
      "https://ns.adobe.com/xdm/context/experienceevent",
      "https://ns.adobe.com/xdm/data/time-series"
  ],
  "meta:containerId": "tenant",
  "imsOrg": "{ORG_ID}",
  "meta:altId": "_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67",
  "meta:xdmType": "object",
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d5cc04eb8d50190001287e4c869ebe67",
  "version": "1.0",
  "meta:resourceType": "schemas",
  "meta:registryMetadata": {
      "repo:createDate": 1552088461236,
      "repo:lastModifiedDate": 1552088470592,
      "xdm:createdClientId": "{CREATED_CLIENT}",
      "xdm:repositoryCreatedBy": "{CREATED_BY}"
  }
}
OBSERVERA

Mer detaljerad information om PATCH begär scheman finns i slutpunktshandbok för scheman.

Nästa steg

I den här guiden beskrivs hur du använder API-anrop för att lägga till enskilda fält från en befintlig fältgrupp i ett schema. Mer information om hur du utför liknande fältbaserade åtgärder i plattformsgränssnittet finns i handboken om fältbaserade arbetsflöden.

Mer information om funktionerna i API:t för schemaregister finns i API-översikt för en fullständig lista över slutpunkter och processer.

På denna sida