行为端点

在体验数据模型(XDM)中,行为定义模式描述的数据性质。 每个XDM类必须引用特定行为,采用该类的所有架构都将继承该特定行为。 对于Platform中的几乎所有用例,有两种可用行为:

  • 记录:提供有关主题属性的信息。主题可以是组织或个人。
  • 时间系列:提供记录主体直接或间接执行某项操作时系统的快照。
注意

平台中有一些用例要求使用不采用上述任一行为的架构。 对于这些情况,可以使用第三种“临时”行为。 有关更多信息,请参阅有关创建临时架构的教程。

有关数据行为如何影响模式组合的更多常规信息,请参阅模式组合基础知识指南。

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将行为分配给类,请参阅类端点指南

在此页面上