Reactor API中的关系

Reactor API中的资源通常彼此相关。 本文档概述了如何在API中建立资源关系,以及每种资源类型的关系要求。

根据相关资源类型,需要一些关系。 必需的关系意味着没有关系父资源不能存在。 所有其他关系都是可选的。

无论是必需关系还是可选关系,在创建相关资源时,系统都会自动建立关系,或者必须手动创建关系。 在手动创建关系时,根据相关资源,可以使用两种方法:

有关每种资源类型的兼容关系列表以及在适用时建立这些关系所需的方法,请参阅关系要求中的部分。

按负载创建关系

在最初创建资源时,必须手动建立某些关系。 要实现此目的,您必须在首次创建父资源时在请求有效负载中提供一个relationship对象。 这些关系的示例包括:

API格式

POST /properties/{PROPERTY_ID}/{RESOURCE_TYPE}
参数 描述
{PROPERTY_ID} 资源所属的属性的ID。
{RESOURCE_TYPE} 要创建的资源类型。

请求

以下请求将创建一个新的rule_component,与rulesextension建立关系。

curl -X POST \
  https://reactor.adobe.io/properties/PRf606dbddfbdc44f580fc6f342b5ff9be/rule_components \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'x-api-key: [KEY]' \
  -H 'x-gw-ims-org-id: [ORG_ID]' \
  -H 'Accept: application/vnd.api+json;revision=1' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
        "data": {
          "attributes": {
            "delegate_descriptor_id": "kessel-test::events::click",
            "name": "My Example Click Event",
            "settings": "{\"elementSelector\":\".accordion\",\"bubbleFireIfChildFired\":true}"
          },
          "relationships": {
            "extension": {
              "data": {
                "id": "EXa2865f4d14204fa094f247406424371b",
                "type": "extensions"
              }
            },
            "rules": {
              "data": [
                {
                  "id": "RLd53598e3f1884e63bbc8e9c95e463dcf",
                  "type": "rules"
                }
              ]
            }
          },
          "type": "rule_components"
        }
      }'
属性 描述
relationships 按有效负载创建关系时必须提供的对象。 此对象中的每个键都表示特定的关系类型。 在上例中,建立了extensionrules关系,这些关系对rule_components是特定的。 有关不同资源的兼容关系类型的更多信息,请参阅按资源划分的关系要求部分
data relationship对象下提供的每个关系类型都必须包含data属性,该属性引用正在与之建立关系的资源的idtype。 您可以通过将data属性格式化为对象数组来创建与同一类型的多个资源的关系,每个对象都包含适用资源的idtype
id 资源的唯一ID。 每个id都必须附带一个同级type属性,以指示相关资源的类型。
type 同级id字段引用的资源类型。 接受的值包括data_elementsrulesextensionsenvironments

通过URL创建关系

与其他资源不同,库通过其自己的专用/relationship端点建立关系。 示例包括:

API格式

POST /properties/{PROPERTY_ID}/libraries/{LIBRARY_ID}/relationships/{RESOURCE_TYPE}
参数 描述
{PROPERTY_ID} 库所属的属性的ID。
{LIBRARY_ID} 要为其创建关系的库的ID。
{RESOURCE_TYPE} 关系所定向的资源类型。 可用值包括environmentdata_elementsextensionsrules

请求

以下请求使用库的/relationships/environment端点创建与环境的关系。

curl -X POST \
  https://reactor.adobe.io/properties/PRf606dbddfbdc44f580fc6f342b5ff9be/libraries/LB10c1fd171cd347f19fcb8659a8d679ef/relationships/environment \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'x-api-key: [KEY]' \
  -H 'x-gw-ims-org-id: [ORG_ID]' \
  -H 'Accept: application/vnd.api+json;revision=1' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
        "data": {
          "id": "ENf395a477d2b24ad696d65b901055b9dc",
          "type": "environments",
        }
      }'
属性 描述
data 引用关系目标资源idtype的对象。 如果要与同一类型的多个资源(如extensionsrules)创建关系,则data属性必须格式化为对象数组,每个对象都包含适用资源的idtype
id 资源的唯一ID。 每个id都必须附带一个同级type属性,以指示相关资源的类型。
type 同级id字段引用的资源类型。 接受的值包括data_elementsrulesextensionsenvironments

按资源开列的关系要求

下表概述了每种资源类型的可用关系(无论是否需要这些关系),以及在适用时手动创建关系的已接受方法。

注意

如果某个关系未列为由有效负载或URL创建,则系统会自动为其分配该关系。

审核事件

关系 必需 按负载创建 按URL创建
property
entity

内部版本

关系 必需 按负载创建 按URL创建
data_elements
extensions
rules
environment
library
property

回调

关系 必需 按负载创建 按URL创建
property

公司

关系 必需 按负载创建 按URL创建
properties

数据元素

关系 必需 按负载创建 按URL创建
libraries
revisions
notes
property
origin
extension
updated_with_extension
updated_with_extension_package

环境

关系 必需 按负载创建 按URL创建
library
builds
host
property

扩展

关系 必需 按负载创建 按URL创建
libraries
revisions
notes
property
origin
extension_package
updated_with_extension_package

主机

关系 必需 按负载创建 按URL创建
property

关系 必需 按负载创建 按URL创建
builds
environment
data_elements
extensions
rules
notes
upstream_library
property
last_build

注释

关系 必需 按负载创建 按URL创建
resource

属性

关系 必需 按负载创建 按URL创建
company
callbacks
environments
libraries
data_elements
extensions
extensions

规则组件

关系 必需 按负载创建 按URL创建
updated_with_extensions_package
updated_with_extension
extension
notes
origin
property
rules
revisions

规则

关系 必需 按负载创建 按URL创建
libraries
revisions
notes
property
origin
rule_components

在此页面上