Reactor API中的關係

Reactor API中的資源通常彼此相關。 本檔案概略說明如何在API中建立資源關係，以及每種資源類型的關係需求。

根據相關資源的類型，需要一些關係。 必要的關係表示沒有該關係父資源不能存在。 所有其他關係均為可選關係。

無論關係是必需的還是可選的，在建立相關資源時系統都會自動建立關係，或者必須手動建立關係。 在手動建立關係的情況下，有兩種可能的方法取決於相關資源：

請參閱 關係要求 以獲取每種資源類型的相容關係清單，以及在適用時建立這些關係所需的方法。

依裝載建立關係

在最初建立資源時，必須手動建立某些關係。 若要完成此操作，您必須提供 relationship 物件（在您首次建立父資源時）。 這些關係的範例包括：

API格式

POST /properties/{PROPERTY_ID}/{RESOURCE_TYPE}
參數 說明
{PROPERTY_ID} 資源所屬屬性的ID。
{RESOURCE_TYPE} 要建立的資源類型。

要求

下列請求會建立新 rule_component，建立關係 rules 和 extension.

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 依裝載建立關係時必須提供的物件。 此對象中的每個鍵表示特定的關係類型。 在上述範例中， extension 和 rules 建立關係，尤其是 rule_components. 有關不同資源的相容關係類型的詳細資訊，請參閱 按資源列出的關係需求.
data 在 relationship 物件必須包含 data 屬性，會參考 id 和 type 與之建立關係的資源。 您可以透過格式化 data 屬性，作為物件的陣列，每個物件都包含 id 和 type 適用資源。
id 資源的唯一ID。 每個 id 必須和兄弟姐妹一起 type 屬性，表示相關資源的類型。
type 由同層引用的資源類型 id 欄位。 接受的值包括 data_elements, rules, extensions，和 environments.

按URL建立關係

與其他資源不同，程式庫可透過自己的專屬資源來建立關係 /relationship 端點。 例如：

API格式

POST /properties/{PROPERTY_ID}/libraries/{LIBRARY_ID}/relationships/{RESOURCE_TYPE}
參數 說明
{PROPERTY_ID} 程式庫所屬屬性的ID。
{LIBRARY_ID} 您要建立關係的程式庫ID。
{RESOURCE_TYPE} 關係所定位的資源類型。 可用值包括 environment, data_elements, extensions，和 rules.

要求

下列請求會使用 /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 參考 id 和 type 關係的目標資源。 如果您要與相同類型的多個資源建立關係(例如 extensions 和 rules), data 屬性必須格式化為對象陣列，每個對象都包含 id 和 type 適用資源。
id 資源的唯一ID。 每個 id 必須和兄弟姐妹一起 type 屬性，表示相關資源的類型。
type 由同層引用的資源類型 id 欄位。 接受的值包括 data_elements, rules, extensions，和 environments.

按資源分列的關係需求

下表概述了每種資源類型的可用關係（無論這些關係是否需要），以及在適用時手動建立關係的接受方法。

注意

如果關係未列為由裝載或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

秘密

關係 必填 由裝載建立 按URL建立
property ✓ ✓
environment ✓ ✓

本頁內容