ドキュメントExperience Platformエクスペリエンスデータモデル（XDM）ガイド

スキーマエンドポイント

最終更新日： 2026年7月13日

作成対象：

  • {"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

スキーマは、Adobe Experience Platformに取り込むデータの設計図と考えることができます。 各スキーマは、クラスと0個以上のスキーマフィールドグループで構成されます。 Schema Registry APIの/schemas エンドポイントを使用すると、エクスペリエンスアプリケーション内のスキーマをプログラムで管理できます。

はじめに

このガイドで使用する API エンドポイントは、Schema Registry API の一部です。 先に進む前に、はじめる前にを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。

スキーマのリストの取得 list

globalまたはtenant コンテナの下にあるすべてのスキーマを一覧表示するには、それぞれ/global/schemasまたは/tenant/schemasにGET リクエストを行います。

NOTE
リソースを一覧表示する場合、Schema Registryは結果セットを300項目に制限します。 この制限を超えるリソースを返すには、ページングパラメーターを使用する必要があります。 また、結果をフィルタリングし、返されるリソースの数を減らすために、追加のクエリパラメーターを使用することをお勧めします。 詳しくは、付録ドキュメントの​ クエリパラメーターの節を参照してください。

API 形式

GET /{CONTAINER_ID}/schemas?{QUERY_PARAMS}
パラメーター
説明
{CONTAINER_ID}
取得するスキーマを格納するコンテナ：Adobeで作成されたスキーマのglobalまたは組織が所有するスキーマのtenant。
{QUERY_PARAMS}
結果をフィルタリングする条件となるクエリパラメーター（オプション）。 使用可能なパラメーターのリストについては、付録ドキュメント ​を参照してください。

リクエスト

次のリクエストは、orderby クエリパラメーターを使用して、tenant コンテナからスキーマのリストを取得し、結果をtitle属性で並べ替えます。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?orderby=title \
  -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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答の形式は、リクエストで送信されたAccept ヘッダーによって異なります。 以下のAccept ヘッダーは、スキーマのリストに使用できます。

Accept ヘッダー
説明
application/vnd.adobe.xed-id+json
各リソースの短いサマリーを返します。 リソースを一覧表示する際に推奨されるヘッダーです。 （上限：300）
application/vnd.adobe.xed+json
元の$refとallOfが含まれている各リソースの完全なJSON スキーマを返します。 （上限：300）

応答

上記のリクエストではapplication/vnd.adobe.xed-id+json Accept ヘッダーが使用されていたため、応答には、各スキーマのtitle、$id、meta:altIdおよびversion属性のみが含まれています。 他のAccept ヘッダー（application/vnd.adobe.xed+json）を使用すると、各スキーマのすべての属性が返されます。 応答に必要な情報に応じて、適切なAccept ヘッダーを選択します。

{
  "results": [
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/0238be93d3e7a06aec5e0655955901ec",
      "meta:altId": "_{TENANT_ID}.schemas.0238be93d3e7a06aec5e0655955901ec",
      "version": "1.4",
      "title": "Hotels"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/0ef4ce0d390f0809fad490802f53d30b",
      "meta:altId": "_{TENANT_ID}.schemas.0ef4ce0d390f0809fad490802f53d30b",
      "version": "1.0",
      "title": "Loyalty Members"
    }
  ],
  "_page": {
        "orderby": "title",
        "next": null,
        "count": 2
    },
    "_links": {
        "next": null,
        "global_schemas": {
            "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas"
        }
    }
}

スキーマの検索 lookup

パスにスキーマのIDを含むGET リクエストを実行することで、特定のスキーマを検索できます。

API 形式

GET /{CONTAINER_ID}/schemas/{SCHEMA_ID}
パラメーター
説明
{CONTAINER_ID}
取得するスキーマを格納するコンテナ：Adobeで作成されたスキーマのglobal、または組織が所有するスキーマのtenant。
{SCHEMA_ID}
検索するスキーマのmeta:altIdまたはURL エンコードされた$idです。

リクエスト

次のリクエストは、パスのmeta:altId値で指定されたスキーマを取得します。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.f579a0b5f992c69458ea408ec36571f7da9de15901bab116 \
  -H 'Accept: application/vnd.adobe.xed+json' \
  -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}'

応答の形式は、リクエストで送信されたAccept ヘッダーによって異なります。 すべてのルックアップリクエストでは、versionをAccept ヘッダーに含める必要があります。 次のAccept ヘッダーを使用できます。

Accept ヘッダー
説明
application/vnd.adobe.xed+json; version=1
$ref および allOf で生、タイトルと説明を含む
application/vnd.adobe.xed-full+json; version=1
$ref および allOf を解決、タイトルと説明を含む
application/vnd.adobe.xed-notext+json; version=1
$ref および allOf で生、タイトルや説明なし
application/vnd.adobe.xed-full-notext+json; version=1
$ref および allOf で解決、タイトルや説明なし
application/vnd.adobe.xed-full-desc+json; version=1
$ref および allOf で解決、説明を含む
application/vnd.adobe.xed-deprecatefield+json; version=1
$ref および allOf を解決、タイトルと説明を含む 非推奨フィールドは、meta:status属性deprecatedで示されます。

応答

応答が成功すると、スキーマの詳細が返されます。 返されるフィールドは、リクエストで送信されたAccept ヘッダーによって異なります。 様々なAccept ヘッダーを試して、回答を比較し、どのヘッダーがユースケースに最適かを判断します。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
  "meta:altId": "_{TENANT_ID}.schemas.20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
  "meta:resourceType": "schemas",
  "version": "1.1",
  "title": "Example schema",
  "type": "object",
  "description": "An example schema created within the tenant container.",
  "allOf": [
      {
          "$ref": "https://ns.adobe.com/xdm/context/profile",
          "type": "object",
          "meta:xdmType": "object"
      },
      {
          "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
          "type": "object",
          "meta:xdmType": "object"
      }
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
      "https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
      "https://ns.adobe.com/xdm/common/auditable",
      "https://ns.adobe.com/xdm/data/record",
      "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
      "repo:createdDate": 1602872911226,
      "repo:lastModifiedDate": 1603381419889,
      "xdm:createdClientId": "{CLIENT_ID}",
      "xdm:lastModifiedClientId": "{CLIENT_ID}",
      "xdm:createdUserId": "{USER_ID}",
      "xdm:lastModifiedUserId": "{USER_ID}",
      "eTag": "84b4da79b7445a4bf1c59269e718065effddb983c492f48e223d49c049c6d589",
      "meta:globalLibVersion": "1.15.4"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}"
}

スキーマの作成 create

スキーマ構成プロセスは、クラスの割り当てから開始されます。 このクラスは、データ（レコードまたは時系列）の主要な動作要素と、取得されるデータを記述するために必要な最小フィールドを定義します。

リレーショナルスキーマと呼ばれる、クラスまたはフィールドグループを含まないスキーマを作成する手順については、「​ リレーショナルスキーマを作成」の節を参照してください。

NOTE
以下の呼び出しの例は、APIでスキーマを作成する方法のベースラインの例に過ぎず、クラスの構成要件は最小限に抑えられ、フィールドグループは作成されません。 フィールドグループとデータタイプを使用してフィールドを割り当てる方法など、APIでスキーマを作成する方法に関する完全な手順については、​ スキーマ作成チュートリアル ​を参照してください。

API 形式

POST /tenant/schemas

リクエスト

リクエストには、クラスの $id を参照する allOf 属性を含める必要があります。 この属性は、スキーマが実装する「基本クラス」を定義します。 この例では、基本クラスは、以前に作成された「プロパティ情報」クラスです。

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -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 '{
        "title":"Property Information",
        "description": "Property-related information.",
        "type": "object",
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
          }
        ]
      }'
プロパティ
説明
allOf
オブジェクトの配列。各オブジェクトは、スキーマが実装するフィールドを持つクラスまたはフィールドグループを参照します。 各オブジェクトには、新しいスキーマが実装するクラスまたはフィールドグループの$idを表す値を持つ単一のプロパティ （$ref）が含まれます。 1つのクラスを指定し、0個以上の追加フィールドグループを指定する必要があります。 上記の例では、allOf配列内の単一のオブジェクトがスキーマのクラスです。

応答

正常な応答は、HTTP ステータス 201（作成済み）と、新しく作成されたスキーマの詳細（$id、meta:altId、versionなど）を含むペイロードを返します。 これらの値は読み取り専用で、Schema Registryによって割り当てられます。

{
    "title": "Property Information",
    "description": "Property-related information.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
        "https://ns.adobe.com/xdm/data/record"
    ],
    "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": 1552088461236,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    }
}

テナントコンテナ内のすべてのスキーマ 🔗を リストにGET リクエストを実行すると、新しいスキーマが含まれるようになりました。 URL エンコードされた$id URIを使用して参照（GET）要求を実行し、新しいスキーマを直接表示できます。

スキーマにフィールドを追加するには、PATCH操作を実行して、スキーマのallOfおよびmeta:extends配列にフィールドグループを追加します。

リレーショナルスキーマを作成 create-relational-schema

AVAILABILITY
Data Mirrorとリレーショナルスキーマは、Adobe Journey Optimizer オーケストレーションキャンペーン​のライセンス保有者が利用できます。 また、ライセンスと機能の有効化に応じて、Customer Journey Analytics ユーザー向けの​ 限定リリース ​としても利用できます。 アクセスについては、Adobe担当者にお問い合わせください。

/schemas エンドポイントにPOST リクエストを行うことで、リレーショナルスキーマを作成します。 リレーショナルスキーマは、個のクラスまたはフィールドグループを含まない、構造化されたリレーショナルスタイルのデータ​を保存します。 スキーマ上でフィールドを直接定義し、論理動作タグを使用してスキーマをリレーショナルとして識別します。

IMPORTANT
リレーショナルスキーマを作成するには、meta:extendsを"https://ns.adobe.com/xdm/data/adhoc-v2"に設定します。 これは​ 論理動作ID ​です（物理的な動作やクラスではありません）。 not​はallOfのクラスまたはフィールドグループを参照し、not​はmeta:extendsのクラスまたはフィールドグループを含めません。

最初にPOST /tenant/schemasを使用してスキーマを作成します。 次に、必要な記述子を記述子API （POST /tenant/descriptors） ​で追加します。

  • プライマリキー記述子: プライマリキーフィールドは​ ルートレベル ​および​ に必須 ​としてマークされている必要があります。
  • ​ バージョン記述子: プライマリキーが存在する場合は​が必要です。
  • 関係記述子: オプション。結合を定義します。取り込み時に基数が適用されません。
  • ​ タイムスタンプ記述子：時系列スキーマの場合、プライマリキーはタイムスタンプフィールドを含む​複合 キーである必要があります。
NOTE
UI スキーマエディターでは、バージョン記述子とタイムスタンプ記述子はそれぞれ「​ バージョン識別子」と「​ タイムスタンプ識別子」として表示されます。
CAUTION
リレーショナルスキーマは​結合スキーマと互換性がありません。 リレーショナルスキーマを使用する場合、union タグをmeta:immutableTagsに適用しないでください。 この設定はUIでブロックされていますが、現在APIによってブロックされていません。 結合スキーマの動作について詳しくは、unions エンドポイントガイド ​を参照してください。

API 形式

POST /tenant/schemas

リクエスト

curl --request POST \
  --url https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -H 'Accept: application/vnd.adobe.xed+json' \
  -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 '{
  "title": "marketing.customers",
  "type": "object",
  "description": "Schema of the Marketing Customers table.",
  "definitions": {
    "customFields": {
      "type": "object",
      "properties": {
        "customer_id": {
          "title": "Customer ID",
          "description": "Primary key of the customer table.",
          "type": "string",
          "minLength": 1
        },
        "name": {
          "title": "Name",
          "description": "Name of the customer.",
          "type": "string"
        },
        "email": {
          "title": "Email",
          "description": "Email of the customer.",
          "type": "string",
          "format": "email",
          "minLength": 1
        }
      },
      "required": ["customer_id"]
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/customFields",
      "meta:xdmType": "object"
    }
  ],
  "meta:extends": ["https://ns.adobe.com/xdm/data/adhoc-v2"],
  "meta:behaviorType": "record"
}
'

リクエスト本文のプロパティ

プロパティ
タイプ
説明
title
文字列
スキーマの表示名。
description
文字列
スキーマの目的の簡単な説明。
type
文字列
リレーショナルスキーマには"object"である必要があります。
definitions
オブジェクト
スキーマフィールドを定義するルートレベルのオブジェクトが含まれます。
definitions.<name>.properties
オブジェクト
フィールド名とデータタイプ：
allOf
配列
ルートレベルのオブジェクト定義を参照します（例：#/definitions/marketing_customers）。
meta:extends
配列
スキーマをリレーショナルとして識別するには、"https://ns.adobe.com/xdm/data/adhoc-v2"を含める必要があります。
meta:behaviorType
文字列
"record"に設定します。 有効で適切な場合にのみ"time-series"を使用してください。
IMPORTANT
関係スキーマのスキーマ進化は、標準スキーマと同じ追加ルールに従います。 PATCH リクエストで新しいフィールドを追加できます。 フィールドの名前や削除などの変更は、データセットにデータが取り込まれていない場合にのみ許可されます。

応答

リクエストが成功すると、HTTP 201 （作成済み）​と作成されたスキーマが返されます。

NOTE
リレーショナルスキーマは、事前にシードされたフィールド（id、timestamp、eventTypeなど）を継承しません。 すべての必須フィールドをスキーマで明示的に定義します。

応答の例

{
  "$id": "https://ns.adobe.com/<TENANT_ID>/schemas/<SCHEMA_UUID>",
  "meta:altId": "_<SCHEMA_ALT_ID>",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "marketing.customers",
  "description": "Schema of the Marketing Customers table.",
  "type": "object",
  "definitions": {
    "marketing_customers": {
      "type": "object",
      "properties": {
        "customer_id": {
          "title": "Customer ID",
          "description": "Primary key of the customer table.",
          "type": "string",
          "minLength": 1
        },
        "name": {
          "title": "Name",
          "description": "Name of the customer.",
          "type": "string"
        },
        "email": {
          "title": "Email",
          "description": "Email of the customer.",
          "type": "string",
          "format": "email",
          "minLength": 1
        }
      },
      "required": ["customer_id"]
    }
  },
  "allOf": [
    { "$ref": "#/definitions/marketing_customers" }
  ],
  "meta:extends": ["https://ns.adobe.com/xdm/data/adhoc-v2"],
  "meta:behaviorType": "record",
  "meta:containerId": "tenant"
}

応答本文のプロパティ

プロパティ
タイプ
説明
$id
文字列
作成されたスキーマの一意のURL。 後続のAPI呼び出しで使用します。
meta:altId
文字列
スキーマの代替ID。
meta:resourceType
文字列
リソースタイプ （常に"schemas"）。
version
文字列
作成時に割り当てられたスキーマバージョン。
title
文字列
スキーマの表示名。
description
文字列
スキーマの目的の簡単な説明。
type
文字列
スキーマタイプ。
definitions
オブジェクト
スキーマで使用される再利用可能なオブジェクトまたはフィールドグループを定義します。 これは通常、メインデータ構造を含み、スキーマのルートを定義するためにallOf配列で参照されます。
allOf
配列
1つ以上の定義（例：#/definitions/marketing_customers）を参照して、スキーマのルートオブジェクトを指定します。
meta:extends
配列
スキーマをリレーショナル （adhoc-v2）として識別します。
meta:behaviorType
文字列
動作タイプ （recordまたはtime-series、有効な場合）。
meta:containerId
文字列
スキーマが格納されているコンテナ （例：tenant）。

リレーショナルスキーマを作成した後でフィールドをリレーショナルスキーマに追加するには、PATCH リクエスト ​を行います。 関係スキーマは継承も自動進化もしません。 フィールドの名前や削除などの構造変更は、データセットにデータが取り込まれていない場合にのみ許可されます。 データが存在する場合、追加の変更 （新しいフィールドの追加など）のみがサポートされます。

新しいルートレベルのフィールド（ルート定義内またはルート properties）を追加できますが、既存のフィールドのタイプを削除、名前変更、変更することはできません。

CAUTION
スキーマを使用してデータセットを初期化すると、スキーマの進化が制限されます。 フィールド名とタイプは事前に注意深く計画する必要があります。データを取り込んだ後は、フィールドを削除または変更することはできません。

スキーマの更新 put

PUT操作を通じてスキーマ全体を置き換え、基本的にリソースを書き換えることができます。 PUT リクエストを通じてスキーマを更新する場合、本文には、POST リクエストで新しいスキーマを作成するときに必要なすべてのフィールドを含める必要があります。

NOTE
スキーマの一部を完全に置き換えるのではなく、一部のみを更新する場合は、​ スキーマの一部の更新の節を参照してください。

API 形式

PUT /tenant/schemas/{SCHEMA_ID}
パラメーター
説明
{SCHEMA_ID}
再書き込みするスキーマのmeta:altIdまたはURL エンコードされた$id。

リクエスト

次のリクエストは、既存のスキーマを置き換え、title、descriptionおよびallOf属性を変更します。

curl -X PUT \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67 \
  -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 '{
        "title":"Commercial Property Information",
        "description": "Information related to commercial properties.",
        "type": "object",
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7"
          }
        ]
      }'

応答

応答が成功すると、更新されたスキーマの詳細が返されます。

{
    "title":"Commercial Property Information",
    "description": "Information related to commercial properties.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7",
        "https://ns.adobe.com/xdm/data/record"
    ],
    "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}"
    }
}

スキーマの一部を更新する patch

PATCH リクエストを使用すると、スキーマの一部を更新できます。 Schema Registryは、add、removeおよびreplaceを含むすべての標準JSON パッチ操作をサポートしています。 JSON パッチについて詳しくは、API の基本ガイドを参照してください。

NOTE
個々のフィールドを更新する代わりに、リソース全体を新しい値に置き換える場合は、PUT操作を使用したスキーマの置き換えの節を参照してください。

PATCHの最も一般的な操作の1つは、以下の例に示すように、事前に定義されたフィールドグループをスキーマに追加することです。

API 形式

PATCH /tenant/schemas/{SCHEMA_ID}
パラメーター
説明
{SCHEMA_ID}
更新するスキーマのURL エンコードされた$id URIまたはmeta:altId。

リクエスト

次のリクエストの例では、フィールドグループの$id値をmeta:extends配列とallOf配列の両方に追加することで、スキーマに新しいフィールドグループを追加しています。

リクエスト本文は配列の形式を取り、各リストオブジェクトは個々のフィールドに対する特定の変更を表します。 各オブジェクトには、実行する操作（op）、操作を実行するフィールド（path）、その操作（value）に含める情報が含まれます。

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": "/meta:extends/-",
          "value":  "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
        },
        {
          "op": "add",
          "path": "/allOf/-",
          "value":  {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
          }
        }
      ]'

応答

応答には、両方の操作が正常に実行されたことが示されます。 フィールドグループ $idがmeta:extends配列に追加され、フィールドグループ $idへの参照（$ref）がallOf配列に表示されるようになりました。

{
    "title": "Property Information",
    "description": "Property-related information.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
    ],
    "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.1",
    "meta:resourceType": "schemas",
    "meta:registryMetadata": {
        "repo:createDate": 1552088461236,
        "repo:lastModifiedDate": 1552088649634,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    }
}

リアルタイム顧客プロファイルで使用するスキーマを有効にする union

スキーマが​ リアルタイム顧客プロファイル ​に参加するには、スキーマのmeta:immutableTags配列にunion タグを追加する必要があります。 これを実現するには、該当するスキーマに対してPATCH リクエストを実行します。

IMPORTANT
不変タグは、設定されるタグですが、削除されることはありません。

API 形式

PATCH /tenant/schemas/{SCHEMA_ID}
パラメーター
説明
{SCHEMA_ID}
有効にするスキーマのURL エンコードされた$id URIまたはmeta:altId。

リクエスト

次のリクエスト例では、既存のスキーマにmeta:immutableTags配列を追加し、配列にunionの単一の文字列値を与えて、プロファイルで使用できるようにします。

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": "/meta:immutableTags",
          "value": ["union"]
        }
      ]'

応答

応答が成功すると、更新されたスキーマの詳細が返され、meta:immutableTags配列が追加されたことを示します。

{
    "title": "Property Information",
    "description": "Property-related information.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
    ],
    "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.1",
    "meta:resourceType": "schemas",
    "meta:registryMetadata": {
        "repo:createDate": 1552088461236,
        "repo:lastModifiedDate": 1552088649634,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    },
    "meta:immutableTags": [
      "union"
    ]
}

このスキーマのクラスの結合を表示して、スキーマのフィールドが表されていることを確認できるようになりました。 詳しくは、unions エンドポイントガイド ​を参照してください。

スキーマの削除 delete

スキーマレジストリからスキーマを削除する必要がある場合があります。 これは、パスで指定されたスキーマ IDを使用してDELETE リクエストを実行することによって実行されます。

API 形式

DELETE /tenant/schemas/{SCHEMA_ID}
パラメーター
説明
{SCHEMA_ID}
削除するスキーマのURL エンコード済み$id URIまたはmeta:altId。

リクエスト

curl -X DELETE \
  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}'

応答

正常な応答の場合は、空白の本文とともに HTTP ステータス 204 （コンテンツなし）が返されます。

削除を確認するには、スキーマに対するルックアップ （GET） リクエストを試みます。 リクエストにAccept ヘッダーを含める必要がありますが、スキーマがスキーマレジストリから削除されたため、HTTP ステータス 404 （見つかりません）を受け取る必要があります。

recommendation-more-help
experience-platform-help-xdm