Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Hier beschrijven we de stappen voor het aanmaken van een nieuwe relatie tussen twee objecten in je repository.
HTTP-responses
HTTP response statuscode | Interpretatie |
201 Created | Relatie succesvol aangemaakt |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
400 Bad Request | Relatie kan niet worden aangemaakt omdat één of meer parameters ontbreken of onjuist zijn |
403 Forbidden | De gebruiker mag geen relatie aanmaken tussen deze twee objecten |
Voorwaarden
Om een relatie tussen twee objecten aan te maken, moet je 'lees- en schrijfrechten' hebben op relaties voor beide objecttypen
Het is alleen mogelijk om een relatie aan te maken tussen twee objecten waarvoor deze combinatie voor dat relatietype is ingeschakeld
Het is alleen mogelijk om een relatie aan te maken tussen twee actieve objecten
Object-ID's en template-ID's moeten bestaan in de tenant
Om een nieuwe relatie aan te maken, doe je een POST-verzoek naar de /relations endpoint met daarin:
Resource/endpoint bestemmings-URL
De header voor je API-verzoek
De request body, die het volgende moet bevatten:
Parameter | Vereist | Type | Beschrijving |
to_object_id | ✓ | string | Unieke identificatie van het doelobject |
from_object_id | ✓ | string | Unieke identificatie van het bronobject |
template_id | ✓ | string | Unieke identificatie van het relatie-template.
LET OP: template_id voor een relatie in public_api is hetzelfde als het relatie-definitie ID op je tenant |
label | X | string | Relatie-label |
relationship_lifecycle_state | X | string | De lifecycle status kan Huidig of Toekomstig zijn. De standaardwaarde is huidig. |
Hieronder vind je een voorbeeld van een API-verzoek om een nieuwe relatie van het type Used by aan te maken tussen twee objecten:
curl -L 'https://public-api.eu.bluedolphin.app/v1/relations' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{ "template_id":"5333e9d68aadd096c838fe93", "from_object_id": "643e9020d97c6a7e28885255", "to_object_id":"64369407346524508498d5a2", "label":"optioneel relatie-label"
"relationship_lifecycle_state": "Toekomstig"}'
Een succesvol verzoek geeft een response terug met een 201 OK HTTP-statuscode en de volgende body:
{ "id": "645b86cb3c2a798711ca40c1"}
Er is nu een nieuwe relatie aangemaakt met het id 645b86cb3c2a798711ca40c1.
De response bevat ook de location response header die de URL aangeeft naar de zojuist aangemaakte relatie. Dus, de location header voor het bovenstaande voorbeeld zou zijn: http://public-api.eu.bluedolphin.app/v1/relations/645b86cb3c2a798711ca40c1.