다음을 사용하여 두 스키마 간의 관계 정의 Schema Registry API

Adobe Experience Platform에서는 다양한 채널에서 고객과 브랜드와의 상호 작용 간의 관계를 이해하는 기능이 중요합니다. 구조 내에서 이러한 관계 정의 Experience Data Model (XDM) 스키마를 사용하면 고객 데이터에 대한 복잡한 통찰력을 얻을 수 있습니다.

한편 스키마 관계는 유니온 스키마 및 의 사용을 통해 추론될 수 있다. Real-Time Customer Profile, 이는 동일한 클래스를 공유하는 스키마에만 적용됩니다. 다른 클래스에 속하는 두 스키마 간의 관계를 설정하려면 전용 관계 필드를 소스 스키마: 별개의 ID를 나타냅니다. 참조 스키마.

NOTE
스키마 레지스트리 API가 참조 스키마를 "대상 스키마"로 참조합니다. 의 대상 스키마와 혼동하지 않도록 하십시오. 데이터 준비 매핑 세트 또는 의 스키마 대상 연결.

이 문서에서는 다음을 사용하여 조직에서 정의한 두 스키마 간의 일대일 관계를 정의하는 자습서를 제공합니다. Schema Registry API.

시작하기

이 튜토리얼을 사용하려면 다음을 이해할 수 있어야 합니다. Experience Data Model (XDM) 및 XDM System. 이 자습서를 시작하기 전에 다음 설명서를 검토하십시오.

이 자습서를 시작하기 전에 다음을 검토하십시오. 개발자 안내서 를 성공적으로 호출하기 위해 알아야 하는 중요한 정보 Schema Registry API. 여기에는 다음 항목이 포함됩니다. {TENANT_ID}, "컨테이너"의 개념 및 요청을 하는 데 필요한 헤더( Accept 헤더 및 가능한 값).

소스 및 참조 스키마 정의 define-schemas

관계에 정의될 두 개의 스키마를 이미 생성했을 것으로 예상됩니다. 이 자습서에서는 조직의 현재 충성도 프로그램("에 정의됨) 구성원 간의 관계를 만듭니다.Loyalty Members"스키마) 및 즐겨 찾는 호텔("에 정의됨) Hotels"스키마).

스키마 관계는 로 표시됩니다. 소스 스키마 내에 다른 필드를 참조하는 필드 있음 참조 스키마. 다음 단계에서 "Loyalty Members""은 소스 스키마가 되지만,"Hotels"은 참조 스키마 역할을 합니다.

IMPORTANT
관계를 설정하려면 두 스키마에 정의된 기본 ID가 있어야 하며 를 활성화할 수 있습니다. Real-Time Customer Profile. 의 섹션을 참조하십시오. 프로필에서 사용할 스키마 활성화 에 따라 스키마를 구성하는 방법에 대한 지침이 필요한 경우 스키마 만들기 튜토리얼에서 참조하십시오.

두 스키마 간의 관계를 정의하려면 먼저 $id 두 스키마의 값. 표시 이름을 알고 있는 경우(title) 내의 스키마를 찾을 수 있습니다 $id 에 GET 요청을 하여 값을 /tenant/schemas 의 엔드포인트 Schema Registry API.

API 형식

GET /tenant/schemas

요청

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -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 'Accept: application/vnd.adobe.xed-id+json'
NOTE
다음 Accept 머리글 application/vnd.adobe.xed-id+json 결과 스키마의 제목, ID 및 버전만 반환합니다.

응답

성공적인 응답은 다음을 포함하여 조직에서 정의한 스키마 목록을 반환합니다. name, $id, meta:altId, 및 version.

{
    "results": [
        {
            "title": "Newsletter Subscriptions",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/192a66930afad02408429174c311ae73",
            "meta:altId": "_{TENANT_ID}.schemas.192a66930afad02408429174c311ae73",
            "version": "1.2"
        },
        {
            "title": "Loyalty Members",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
            "meta:altId": "_{TENANT_ID}.schemas.2c66c3a4323128d3701289df4468e8a6",
            "version": "1.5"
        },
        {
            "title": "Hotels",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
            "meta:altId": "_{TENANT_ID}.schemas.d4ad4b8463a67f6755f2aabbeb9e02c7",
            "version": "1.0"
        }
    ],
    "_page": {
        "orderby": "updated",
        "next": null,
        "count": 3
    },
    "_links": {
        "next": null,
        "global_schemas": {
            "href": "https://platform-stage.adobe.io/data/foundation/schemaregistry/global/schemas"
        }
    }
}

레코드 $id 간의 관계를 정의할 두 스키마의 값입니다. 이 값은 이후 단계에서 사용됩니다.

소스 스키마에 대한 참조 필드 정의

다음 범위 내 Schema Registry관계 설명자는 관계형 데이터베이스 테이블의 외래 키와 유사하게 작동합니다. 소스 스키마의 필드는 참조 스키마의 기본 id 필드에 대한 참조로 사용됩니다. 소스 스키마에 이 용도로 사용할 필드가 없는 경우 새 필드로 스키마 필드 그룹을 만들고 스키마에 추가해야 할 수 있습니다. 이 새 필드에는 typestring.

IMPORTANT
소스 스키마는 기본 ID를 참조 필드로 사용할 수 없습니다.

이 자습서에서는 참조 스키마 "Hotels"다음 포함: hotelId 스키마의 기본 id 역할을 하는 필드입니다. 단, 소스 스키마 "Loyalty Members에 대한 참조로 사용할 전용 필드가 없습니다. hotelId따라서 스키마에 새 필드를 추가하려면 사용자 정의 필드 그룹을 만들어야 합니다. favoriteHotel.

NOTE
소스 스키마에 참조 필드로 사용하려는 전용 필드가 이미 있는 경우 의 단계로 건너뛸 수 있습니다. 참조 설명자 만들기.

새 필드 그룹 만들기

스키마에 새 필드를 추가하려면 먼저 필드 그룹에서 정의해야 합니다. 에 POST 요청을 하여 새 필드 그룹을 만들 수 있습니다. /tenant/fieldgroups 엔드포인트.

API 형식

POST /tenant/fieldgroups

요청

다음 요청은 를 추가하는 새 필드 그룹을 만듭니다. favoriteHotel 필드 아래 _{TENANT_ID} 추가되는 모든 스키마의 네임스페이스.

curl -X POST\
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups \
  -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 '{
        "type": "object",
        "title": "Favorite Hotel",
        "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"],
        "description": "Favorite hotel field group for the Loyalty Members schema.",
        "definitions": {
            "favoriteHotel": {
              "properties": {
                "_{TENANT_ID}": {
                  "type":"object",
                  "properties": {
                    "favoriteHotel": {
                      "title": "Favorite Hotel",
                      "type": "string",
                      "description": "Favorite hotel for a Loyalty Member."
                    }
                  }
                }
              }
            }
        },
        "allOf": [
            {
              "$ref": "#/definitions/favoriteHotel"
            }
        ]
      }'

응답

응답이 성공하면 새로 만든 필드 그룹의 세부 정보가 반환됩니다.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/mixins/3387945212ad76ee59b6d2b964afb220",
    "meta:altId": "_{TENANT_ID}.mixins.3387945212ad76ee59b6d2b964afb220",
    "meta:resourceType": "mixins",
    "version": "1.0",
    "type": "object",
    "title": "Favorite Hotel",
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "Favorite hotel field group for the Loyalty Members schema.",
    "definitions": {
        "favoriteHotel": {
            "properties": {
                "_{TENANT_ID}": {
                    "type": "object",
                    "properties": {
                        "favoriteHotel": {
                            "title": "Favorite Hotel",
                            "type": "string",
                            "description": "Favorite hotel for a Loyalty Member.",
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/favoriteHotel"
        }
    ],
    "meta:xdmType": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:containerId": "tenant",
    "meta:tenantNamespace": "_{TENANT_ID}",
    "meta:registryMetadata": {
        "eTag": "quM2aMPyb2NkkEiZHNCs/MG34E4=",
        "palm:sandboxName": "prod"
    }
}
속성
설명
$id
시스템이 새 필드 그룹의 읽기 전용 고유 식별자입니다. URI 형식을 사용합니다.

레코드 $id 소스 스키마에 필드 그룹을 추가하는 다음 단계에서 사용할 필드 그룹의 URI입니다.

소스 스키마에 필드 그룹 추가

필드 그룹을 만든 후에는 PATCH에 요청하여 소스 스키마에 추가할 수 있습니다. /tenant/schemas/{SCHEMA_ID} 엔드포인트.

API 형식

PATCH /tenant/schemas/{SCHEMA_ID}
매개변수
설명
{SCHEMA_ID}
URL로 인코딩됨 $id URI 또는 meta:altId 소스 스키마.

요청

다음 요청은 를 추가합니다.Favorite Hotel"필드 그룹을 ""로Loyalty Members"스키마.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.533ca5da28087c44344810891b0f03d9 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
    {
      "op": "add",
      "path": "/allOf/-",
      "value":  {
        "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/3387945212ad76ee59b6d2b964afb220"
      }
    }
  ]'
속성
설명
op
수행할 PATCH 작업입니다. 이 요청은 add 작업.
path
새 리소스를 추가할 스키마 필드의 경로. 스키마에 필드 그룹을 추가할 때 값은 "/allOf/-"여야 합니다.
value.$ref
다음 $id 추가할 필드 그룹의 입니다.

응답

성공적인 응답은 업데이트된 스키마의 세부 정보를 반환하며 여기에는 이제 $ref 아래에 추가된 필드 그룹의 값 allOf 배열입니다.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
    "meta:altId": "_{TENANT_ID}.schemas.2c66c3a4323128d3701289df4468e8a6",
    "meta:resourceType": "schemas",
    "version": "1.1",
    "type": "object",
    "title": "Loyalty Members",
    "description": "",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/ec16dfa484358f80478b75cde8c430d3"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/identitymap"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/3387945212ad76ee59b6d2b964afb220"
        }
    ],
    "meta:containerId": "tenant",
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:tenantNamespace": "_{TENANT_ID}",
    "imsOrg": "{ORG_ID}",
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/profile",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/xdm/common/extensible",
        "https://ns.adobe.com/xdm/common/auditable",
        "https://ns.adobe.com/xdm/context/profile-person-details",
        "https://ns.adobe.com/xdm/context/profile-personal-details",
        "https://ns.adobe.com/{TENANT_ID}/mixins/ec16dfa484358f80478b75cde8c430d3",
        "https://ns.adobe.com/{TENANT_ID}/mixins/61969bc646b66a6230a7e8840f4a4d33"
    ],
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557525483804,
        "repo:lastModifiedDate": 1566419670915,
        "xdm:createdClientId": "{API_KEY}",
        "xdm:lastModifiedClientId": "{CLIENT_ID}",
        "eTag": "ITNzu8BVTO5pw9wfCtTTpk6U4WY="
    }
}

참조 ID 설명자 만들기 reference-identity

스키마 필드는 관계에서 다른 스키마에 대한 참조로 사용되는 경우 해당 필드에 참조 ID 설명자가 적용되어야 합니다. 다음 이후 favoriteHotel 의 필드Loyalty Members"은(는) hotelId 의 필드Hotels", favoriteHotel 참조 id 설명자를 지정해야 합니다.

에 POST 요청을 하여 소스 스키마에 대한 참조 설명자를 만듭니다. /tenant/descriptors 엔드포인트.

API 형식

POST /tenant/descriptors

요청

다음 요청은 다음에 대한 참조 설명자를 생성합니다. favoriteHotel 소스 스키마 의 필드 "Loyalty Members".

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
  -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 '{
    "@type": "xdm:descriptorReferenceIdentity",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/533ca5da28087c44344810891b0f03d9",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/favoriteHotel",
    "xdm:identityNamespace": "Hotel ID"
  }'
매개변수
설명
@type
정의 중인 설명자 유형. 참조 설명자의 경우 값은 다음과 같아야 합니다. xdm:descriptorReferenceIdentity.
xdm:sourceSchema
다음 $id 소스 스키마 URL.
xdm:sourceVersion
소스 스키마의 버전 번호입니다.
sourceProperty
참조 스키마의 기본 ID를 참조하는 데 사용할 소스 스키마 필드의 경로.
xdm:identityNamespace
참조 필드의 ID 네임스페이스. 참조 스키마의 기본 ID와 동일한 네임스페이스여야 합니다. 다음을 참조하십시오. id 네임스페이스 개요 추가 정보.

응답

성공한 응답은 소스 필드에 대해 새로 생성된 참조 설명자의 세부 정보를 반환합니다.

{
    "@type": "xdm:descriptorReferenceIdentity",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/533ca5da28087c44344810891b0f03d9",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/favoriteHotel",
    "xdm:identityNamespace": "Hotel ID",
    "meta:containerId": "tenant",
    "@id": "53180e9f86eed731f6bf8bf42af4f59d81949ba6"
}

관계 설명자 만들기 create-descriptor

관계 설명자는 소스 스키마와 참조 스키마 간의 일대일 관계를 설정합니다. 소스 스키마의 해당 필드에 대한 참조 ID 설명자를 정의한 후에는 POST에 요청을 하여 새 관계 설명자를 생성할 수 있습니다 /tenant/descriptors 엔드포인트.

API 형식

POST /tenant/descriptors

요청

다음 요청은 와 함께 새 관계 설명자를 만듭니다.Loyalty Members소스 스키마로 " 및 "Hotels를 참조 스키마로 사용하십시오.

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
  -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 '{
    "@type": "xdm:descriptorOneToOne",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/favoriteHotel",
    "xdm:destinationSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
    "xdm:destinationVersion": 1,
    "xdm:destinationProperty": "/_{TENANT_ID}/hotelId"
  }'
매개변수
설명
@type
생성할 설명자 유형. 다음 @type 관계 설명자의 값은 다음과 같습니다. xdm:descriptorOneToOne.
xdm:sourceSchema
다음 $id 소스 스키마 URL.
xdm:sourceVersion
소스 스키마의 버전 번호입니다.
xdm:sourceProperty
소스 스키마의 참조 필드 경로.
xdm:destinationSchema
다음 $id 참조 스키마의 URL.
xdm:destinationVersion
참조 스키마의 버전 번호입니다.
xdm:destinationProperty
참조 스키마의 기본 ID 필드 경로.

응답

성공한 응답은 새로 생성된 관계 설명자의 세부 정보를 반환합니다.

{
    "@type": "xdm:descriptorOneToOne",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/favoriteHotel",
    "xdm:destinationSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
    "xdm:destinationVersion": 1,
    "xdm:destinationProperty": "/_{TENANT_ID}/hotelId",
    "meta:containerId": "tenant",
    "@id": "76f6cc7105f4eaab7eb4a5e1cb4804cadc741669"
}

다음 단계

이 자습서에 따라 두 스키마 간의 일대일 관계를 생성했습니다. 을(를) 사용하여 설명자를 사용하는 방법에 대한 자세한 내용은 Schema Registry API에서 다음을 참조하십시오. 스키마 레지스트리 개발자 안내서. UI에서 스키마 관계를 정의하는 방법에 대한 단계는 스키마 편집기를 사용하여 스키마 관계 정의.

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07