動作エンドポイント

エクスペリエンスデータモデル(XDM)では、スキーマが説明するデータの特性が動作によって定義されます。 各XDMクラスは、特定の動作を参照する必要があります。この動作は、そのクラスを使用するすべてのスキーマが継承します。 プラットフォームのほとんどすべての使用例で、次の2つの動作が利用できます。

  • レコード:件名の属性に関する情報を提供します。主体は、組織または個人にすることができます。
  • 時系列:レコードの件名によって直接または間接的にアクションが実行された時点のシステムのスナップショットを提供します。
メモ

プラットフォームでは、上記のいずれの動作も使用しないスキーマの使用が必要な使用例があります。 このような場合は、3つ目の「アドホック」動作を使用できます。 詳しくは、アドホックスキーマの作成のチュートリアルを参照してください。

データ動作がスキーマ構成に与える影響について詳しくは、スキーマ構成の基本のガイドを参照してください。

Schema Registry APIの/behaviorsエンドポイントを使用すると、globalコンテナで使用可能な動作を表示できます。

はじめに

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

動作のリストを取得する

/behaviorsエンドポイントにGETリクエストを行うと、使用可能なすべての動作のリストを取得できます。

API 形式

GET /global/behaviors

リクエスト

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

応答

{
    "results": [
        {
            "$id": "https://ns.adobe.com/xdm/data/record",
            "meta:altId": "_xdm.data.record",
            "version": "1.16.4",
            "title": "Record Schema"
        },
        {
            "$id": "https://ns.adobe.com/xdm/data/adhoc",
            "meta:altId": "_xdm.data.adhoc",
            "version": "1.16.4",
            "title": "Ad Hoc Schema"
        },
        {
            "$id": "https://ns.adobe.com/xdm/data/time-series",
            "meta:altId": "_xdm.data.time-series",
            "version": "1.16.4",
            "title": "Time-series Schema"
        }
    ],
    "_page": {
        "orderby": "updated",
        "next": null,
        "count": 3
    },
    "_links": {
        "next": null
    }
}

動作を検索

/behaviorsエンドポイントへのGETリクエストのパスにIDを指定すると、特定の動作を調べることができます。

API 形式

GET /global/behaviors/{BEHAVIOR_ID}
パラメーター 説明
{BEHAVIOR_ID} 検索する動作のmeta:altIdまたはURLエンコードされた$idです。

リクエスト

次のリクエストは、リクエストパスにmeta:altIdを指定することで、レコード動作の詳細を取得します。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors/_xdm.data.record \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed+json;version=1'

応答

正常に完了した応答は、バージョン、説明、およびその動作を使用するクラスに提供する属性など、動作の詳細を返します。

{
    "$id": "https://ns.adobe.com/xdm/data/record",
    "meta:altId": "_xdm.data.record",
    "meta:resourceType": "behaviors",
    "version": "1.16.4",
    "title": "Record Schema",
    "type": "object",
    "description": "Used to indicate the behavior of record data semantic when composed into data schemas.",
    "definitions": {
        "record": {
            "properties": {
                "_id": {
                    "title": "Identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "A unique identifier for the record.",
                    "meta:xdmType": "string",
                    "meta:xdmField": "@id"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/record",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:xdmType": "object",
    "meta:status": "stable",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "meta:registryMetadata": {
        "repo:createdDate": 1606266789446,
        "repo:lastModifiedDate": 1606266789446,
        "eTag": "2cc114a54949a9668fe2ad046ccece59192e1bfa28f14e5ac7c893acb7820ba2",
        "meta:globalLibVersion": "1.16.4"
    }
}

次の手順

このガイドでは、Schema Registry APIでの/behaviorsエンドポイントの使用について説明しました。 APIを使用してクラスに動作を割り当てる方法については、クラスエンドポイントガイドを参照してください。

このページ

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now