Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Je kunt een relatie gedeeltelijk bijwerken door de gewenste waarden voor relatie-eigenschappen in te stellen en deze door te geven aan de endpoint PATCH /relations/{id}. De body hoeft alleen de elementen te bevatten waarvan de waarden gewijzigd moeten worden.
HTTP-responsen
HTTP response statuscode | Interpretatie |
200 OK | Relatie succesvol bijgewerkt |
400 Bad Request | Relatie kan niet worden bijgewerkt omdat één of meer parameters ontbreken of onjuist zijn |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
403 Forbidden | De gebruiker mag deze relatie niet bijwerken |
Om een bestaande relatie gedeeltelijk bij te werken, gebruik je de PATCH /relations/{id} endpoint en geef je het volgende op in je verzoek:
Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door het ID van de relatie die je wilt bijwerken.
De header voor je API-verzoek
De request body, die alleen de waarden bevat die je wilt bijwerken:
Eigenschap | Type | Mutabel | Beschrijving |
remark | string | ✓ | De opmerking/het label van de relatie |
relationship_lifecycle_state | string | X | De lifecycle status kan Huidig of Toekomstig zijn |
boem | array |
| Informatie over de relatievragenlijst |
boem[].id | string | X | Unieke identificatie voor de vragenlijst |
boem[].name | string | X | De naam van de vragenlijst |
boem[].items | array | X | Een lijst met velden van de vragenlijst |
boem[].items[].id | string | X | Unieke identificatie voor het vragenlijstveld |
boem[].items[].field_type | string | X | Eén van de volgende waarden:
|
boem[].items[].name | string | X | De naam van het vragenlijstveld |
boem[].items[].value | string | ✓ | De waarde van het vragenlijstveld |
Let op: alle waarden die worden opgegeven voor niet-aanpasbare eigenschappen worden genegeerd. Als er niet-aanpasbare eigenschappen in je verzoek zijn opgenomen, worden deze niet gewijzigd, ook al geeft de response de statuscode 200 OK terug.
Veldtypen van de vragenlijst
Veldtype | Regels |
Date | De opgegeven waarde moet in het formaat dd-MM-jjjj zijn |
Text | De opgegeven waarde is beperkt tot de ingestelde MaxLength |
RichText | De opgegeven waarde wordt "geschoond" om mogelijke HTML-code-injectie te voorkomen |
Multi | Opgegeven waarden staan in de lijst met mogelijke waarden. Waarden worden gescheiden door een pipe | |
Dropdown | Opgegeven waarden staan in de lijst met mogelijke waarden |
Multiselect dropdown | Opgegeven waarden staan in de lijst met mogelijke waarden. Waarden worden gescheiden door een pipe | |
Checkbox | De opgegeven waarde is "yes" of "no". |
Number | Waarden worden aangepast aan het ingestelde aantal decimalen |
Currency | Waarden worden aangepast aan het ingestelde aantal decimalen |
Relatie | Niet ondersteund |
Let op: als een opgegeven waarde niet voldoet aan de gespecificeerde regels, wordt deze leeggemaakt.
Hieronder vind je een voorbeeld van een API-verzoek om een vragenlijst met meerdere velden bij te werken voor een bestaande relatie. Stuur een verzoek met de body waarin de gewijzigde waarden voor de vragenlijst Nieuw Formulier zijn opgenomen.
In het volgende voorbeeld worden de niet-aanpasbare eigenschappen name en field_type genegeerd. Toch tonen we alle velden in de request body voor de volledigheid.
curl -L -X PATCH 'https://public-api.eu.bluedolphin.app/v1/relations/645a3daf3c2a798611bb0dfc' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{ "remark": "",
"relationship_lifecycle_state": "Toekomstig" "boem": [ { "id": "6552362cc653174bfa27d4a1", "name": "Nieuw Formulier", "items": [ { "field_type": "checkbox", "id": "35082bda-c0d3-4f37-99bb-dc69c735fc34", "name": "Checkbox", "value": "yes" }, { "field_type": "date", "id": "2a80a635-1847-4540-aad6-935194a40741", "name": "Date", "value": "01-05-2023" }, { "field_type": "multiselect", "id": "e35d3076-1833-49f8-8b03-2b72d676dc77", "name": "Dropdown multiple select", "value": "Answer 3" }, { "field_type": "hyperlink", "id": "007e36d0-8d8d-4390-8430-638c7096c58d", "name": "Hyperlink", "value": "https://google.com" }, { "field_type": "multiline", "id": "cf1606ca-8889-4c98-8b8d-794331f9528d", "name": "Multiple text lines", "value": "Hello" }, { "field_type": "number", "id": "55d13af5-f68e-4f13-936f-86bacafa2a60", "name": "Number", "value": "321" }, { "field_type": "text", "id": "9bde0475-0f1c-4c1a-8fb8-9e4dbaf51ee2", "name": "Text", "value": "Lorem Ipsum" }, { "field_type": "richtext", "id": "9e0e1c13-1cbe-4cfe-a2f3-8057bab5c5fe", "name": "Formatted text", "value": "Hello" }, { "field_type": "currency", "id": "fc06f15a-e8af-4804-943d-450cde9b3b49", "name": "Currency dollar", "value": "999.99" } ] } ]}'
Een geslaagde call geeft een response terug met een 200 OK HTTP statuscode en de volgende body:
"Ok"