Reactor API中的關係

上次更新: 2023-05-25
  • 主題:
  • Tags
    檢視有關此主題的更多資訊
  • 建立對象:
  • Developer
    User
    Admin
    Leader

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 必須搭配同層級 type 屬性,指出相關資源的型別。
type 同層級參照的資源型別 id 欄位。 接受的值包括 data_elementsrulesextensions、和 environments.

依URL建立關係

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

API格式

POST /properties/{PROPERTY_ID}/libraries/{LIBRARY_ID}/relationships/{RESOURCE_TYPE}
參數 說明
{PROPERTY_ID} 程式庫所屬屬性的ID。
{LIBRARY_ID} 您要為其建立關係的資料庫ID。
{RESOURCE_TYPE} 關係所定位的資源型別。 可用的值包括 environmentdata_elementsextensions、和 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 參照「 」的物件 idtype 關聯的目標資源。 如果您要建立與相同型別的多個資源的關係(例如 extensionsrules), data 屬性必須格式化為物件陣列,且每個物件包含 idtype 適用的資源。
id 資源的唯一識別碼。 每個 id 必須搭配同層級 type 屬性,指出相關資源的型別。
type 同層級參照的資源型別 id 欄位。 接受的值包括 data_elementsrulesextensions、和 environments.

依資源的關係需求

下表概述每種資源型別的可用關係(無論這些關係是否必要),以及手動建立關係的可接受方法(如適用)。

注意

如果關係未列為由承載或URL建立,則由系統自動指派。

稽核事件

關係 必填 依裝載建立 依URL建立
property ✓ (N)
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

本頁內容