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 om een enkele relatie op te halen in BlueDolphin. Deze endpoint wordt gebruikt om een specifieke relatie uit de repository op te halen of om te verifiëren dat een relatie succesvol is verwijderd en niet meer bestaat.
HTTP-responses
HTTP response status code | Interpretatie |
200 OK | Relatie succesvol opgehaald |
400 Bad Request | Relatie kan niet worden gevonden of geladen |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
Om een bestaande relatie op te halen, doe je een GET-verzoek naar de /relations/{id} endpoint met:
Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door het ID van de relatie die je wilt ophalen.
De header voor je API-verzoek
Om de bestaande relatie met het id 645a3daf3c2a798611bb0dfc op te halen, sturen we een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/relations/645a3daf3c2a798611bb0dfc.
curl -L 'https://public-api.eu.bluedolphin.app/v1/relations/645a3daf3c2a798611bb0dfc' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor de relatie |
remark | string | De opmerking/het label van de relatie |
type | object | Informatie over het relatietype waarop de relatie is gebaseerd |
relationship | object | Informatie over de relatiedefinitie |
relationship_lifecycle_state | string | De lifecycle status kan Huidig of Toekomstig zijn |
created_information | object | Informatie over het aanmaken van de relatie |
modified_information | object | Informatie over het wijzigen van de relatie |
status | number | Geeft aan of de relatie actief (2), uitgeschakeld (4) of archived (5) is. Let op: het ophalen van uitgeschakelde relaties is niet mogelijk en geeft een 400 status code. |
source_id | string | Unieke identificatie voor de bron |
source_type | object | Informatie over het objecttype waarop het bronobject is gebaseerd |
source_workspace | object | Informatie over de workspace waar het bronobject zich bevindt (Zie de tabel Workspace) |
target_id | string | Unieke identificatie voor het doel |
target_type | object | Informatie over het objecttype waarop het doelobject is gebaseerd |
target_workspace | object | Informatie over de workspace waar het doelobject zich bevindt (Zie de tabel Workspace) |
boem | array | Informatie over de relatievragenlijst |
boem[].id | string | Unieke identificatie voor de vragenlijst |
boem[].name | string | De naam van de vragenlijst |
boem[].items | array | Een lijst met velden van de vragenlijst |
boem[].items[].id | string | Unieke identificatie voor het veld van de vragenlijst |
boem[].items[].name | string | De naam van het veld van de vragenlijst |
boem[].items[].value | string | De waarde van het veld van de vragenlijst |
Workspace
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor de workspace |
name | string | De naam van de workspace |
Gebruikersinformatie
Eigenschap | Type | Beschrijving |
date | string | De stringversie van de ISO datum en tijd |
user_id | string | Unieke identificatie voor de gebruiker |
first_name | string | De voornaam van de gebruiker |
last_name | string | De achternaam van de gebruiker |
Een succesvol verzoek geeft een response met een 200 OK HTTP status code en de volgende body:
{ "id": "645a3daf3c2a798611bb0dfc", "remark": "optioneel relatielabel",
"relationship_lifecycle_state": "Huidig" "type": { "id": "5478e9d66bbaa096c838fe93", "name": "Used By Relatie", "name_internal": "usedby" }, "relationship": { "template_id": "5478e9d66bbaa096c838fe93", "name": "gebruikt door", "type": "usedby" }, "created_information": { "user_id": "000000000000000000000000", "first_name": "BlueDolphin", "last_name": "", "date": "2023-05-10T11:58:03.04Z" }, "modified_information": null, "status": 2, "source_id": "643e9020d97c6a7e28775255", "source_workspace": { "id": "63f620763279a10a8eefa7b0", "name": "main" }, "source_type": { "id": "640b3d7d4a28b925fcf8b8b2", "name": "Applicatie", "name_internal": "application_component" }, "target_id": "64369407346524508498d5a2", "target_type": { "id": "5d25c4bc0c0ba6e79c23d663", "name": "Bedrijfsproces", "name_internal": "business_process" }, "target_workspace": { "id": "63f620763279a10a8eefa7b0", "name": "main" }, "boem": [ { "id": "645cc42f8a072cbafe74ffbe", "name": "Het gebruik van BlueDolphin", "items": [ { "field_type": "multiselect", "id": "638204ec-9317-4c8c-a94f-b79e74b16e7a", "name": "Hoe vaak gebruik je BD?", "value": "" } ] } ]}