Relationer i reaktors-API

Resurserna i Reaktors API är ofta relaterade till varandra. Det här dokumentet innehåller en översikt över hur resursrelationer är upprättade i API:t och relationskraven för varje resurstyp.

Beroende på vilken typ av resurs det är fråga om krävs vissa relationer. En obligatorisk relation innebär att den överordnade resursen inte kan finnas utan relationen. Alla andra relationer är valfria.

Oberoende av om de är obligatoriska eller valfria etableras relationer antingen automatiskt av systemet när relevanta resurser skapas, eller också måste de skapas manuellt. Om du skapar relationer manuellt finns det två möjliga metoder beroende på den aktuella resursen:

I avsnittet relationskrav finns en lista över kompatibla relationer för varje resurstyp och de metoder som krävs för att upprätta dessa relationer där det är tillämpligt.

Skapa en relation med nyttolast payload

Vissa relationer måste upprättas manuellt när du skapar en resurs. För att uppnå detta måste du tillhandahålla ett relationship-objekt i nyttolasten för begäran när du först skapar den överordnade resursen. Exempel på sådana relationer är:

API-format

POST /properties/{PROPERTY_ID}/{RESOURCE_TYPE}

Begäran

Följande begäran skapar en ny rule_component som upprättar relationer med rules och en 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"
        }
      }'

Skapa en relation utifrån URL url

Till skillnad från andra resurser upprättar bibliotek relationer via sina egna dedikerade /relationship-slutpunkter. Exempel:

API-format

POST /properties/{PROPERTY_ID}/libraries/{LIBRARY_ID}/relationships/{RESOURCE_TYPE}

Begäran

Följande begäran använder /relationships/environment-slutpunkten för ett bibliotek för att skapa en relation med en miljö.

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",
        }
      }'

Relationskrav per resurs requirements

I följande tabeller beskrivs de tillgängliga relationerna för varje resurstyp, oavsett om dessa relationer är nödvändiga eller inte, och den metod som accepteras för att manuellt skapa relationen där det är tillämpligt.

Granskningshändelser

Bygger

Återanrop

Företag

Dataelement

Miljöer

Tillägg

Värdar

Bibliotek

Anteckningar

Egenskaper

Regelkomponenter

Regler

Hemligheter