Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.

Deze endpoint wordt gebruikt om een bestaande objectdefinitie te vervangen. Je kunt verschillende attributen van een objectdefinitie bijwerken door de gewenste waarden in te stellen en deze door te geven aan de endpoint PUT /object-definitions/{id}.

Geef het volgende op in je verzoek:

Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door de ID van de objectdefinitie die je wilt bijwerken/vervangen.
De header voor je API-verzoek
De request body

LET OP: De request body bevat waarden voor alle parameters die je wilt toevoegen en behouden voor een bepaalde definitie. Als je gegevens weglaat in een PUT-call, worden deze verwijderd.

HTTP-responses

HTTP response statuscode	Betekenis
202 Accepted	Toegevoegd aan de wachtrij om verwerkt te worden
400 Bad Request	Voert de validatie uit op de PUT-body. Geeft aan welke eigenschappen ongeldig waren, als de objectdefinitie-ID niet in de database wordt gevonden of als er een andere wijziging bezig is. Foutmeldingen: Er is mogelijk een wijziging bezig. Probeer het later opnieuw. De gevraagde objectdefinitie met ID 'id' is niet gevonden in de database
401 Unauthorized	Ongeldige of ontbrekende API key secret en/of tenant
403 Forbidden	De gebruiker mag deze objectdefinitie niet bijwerken

Door het langdurige proces achter deze endpoint, geeft een geldig verzoek altijd een 202 Accepted HTTP-statuscode en de response body terug. Een 202 Accepted betekent dat het verzoek naar een wachtrij is gestuurd en later wordt verwerkt.

Voorwaarden

is_mandatory moet true zijn als je de waarde van een vastgezette eigenschap wilt bijwerken
Als het verzoek een objectdefinitie id bevat die aanwezig is in de database en het juiste formaat heeft, wordt een 202 OK geretourneerd
Als het verzoek een id bevat met een onjuist formaat, wordt een 400 Bad Request geretourneerd
Verplichte/vastgezette eigenschappen kunnen niet worden verwijderd
Eigenschappen kunnen niet worden hernoemd

Gekoppelde vragen (op zowel eigenschappen als vragenlijsten) en bronkoppelingen worden niet ondersteund. Als deze zijn geconfigureerd op een objectdefinitie, wordt de configuratie verwijderd na een update via de publieke API.

Een mogelijke workaround is om alle vastgezette eigenschappen weg te laten bij een update. Op deze manier wordt de gekoppelde vraag voor de vastgezette eigenschap niet beïnvloed. De gekoppelde vragen op vragenlijsten en niet-vastgezette eigenschappen, evenals de bronkoppelingen, worden echter nog steeds beïnvloed.

Parameter	Type	Mutabel	Beschrijving
id	string	X	Unieke identificatie voor de objectdefinitie. Dit is verplicht, moet al bestaan en overeenkomen met de ID in de URL.
name	string	✓	De naam van de objectdefinitie. Moet uniek zijn binnen de tenant, mag niet leeg zijn en tussen de één en 255 tekens bevatten.
object_properties	array		Een lijst van objecteigenschappen. Als deze niet wordt toegevoegd of leeg is, worden alle niet-vastgezette eigenschappen verwijderd.
object_properties[].name	string	✓	De naam van de objecteigenschap. Moet uniek zijn binnen de objectdefinitie, mag niet leeg zijn en tussen de één en 255 tekens bevatten.
object_properties[].value	string	✓	De standaardwaarde van de objecteigenschap. Moet tussen de één en 255 tekens bevatten.
object_properties[].is_mandatory	boolean	✓	Geeft aan of de eigenschap is vastgezet of niet. Standaardwaarde is 'false'.
related_boem	array	✓	Een lijst van vragenlijsten. Als deze niet wordt toegevoegd of leeg is, worden de vragenlijsten verwijderd.
related_boem[].id	string	✓	Unieke identificatie voor het vragenlijstveld

Objectdefinitie hernoemen

Om de naam van een objectdefinitie te wijzigen, gebruik je de PUT /object-definitions/{id} endpoint en geef je het volgende op in je verzoek:

Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door de ID van de objectdefinitie die je wilt bijwerken/vervangen.
De header voor je API-verzoek
De request body die alle parameters moet bevatten die je wilt behouden in het vervangende bedrijfsmiddel

Hieronder vind je een voorbeeld van een API-verzoek om de name van de objectdefinitie te wijzigen naar New Application. Stuur een PUT-verzoek met de body die de gewenste waarde voor de parameter name bevat.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{    "name": "New Application",    "object_properties": [],    "related_boem": []}'

Een geldig verzoek geeft een response met een 202 Accepted HTTP-statuscode en de volgende body terug:

{    "result": "OK"}

Een objectvragenlijst toevoegen

Om een bestaande vragenlijst toe te voegen aan een objectdefinitie, doe je een PUT-verzoek naar de /object-definitions/{id} endpoint met daarin:

Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door de ID van de objectdefinitie die je wilt bijwerken.
De header voor je API-verzoek
De request body die alle parameters moet bevatten die je wilt behouden in het vervangende bedrijfsmiddel

De term boem die in de implementatie wordt gebruikt, verwijst naar het concept vragenlijst. Alle parameters met het boem-element worden gebruikt om vragenlijsten in BlueDolphin te beheren.

Het onderstaande voorbeeld toont een API-verzoek om de bestaande objectvragenlijsten Application Info en Application Questionnaire toe te voegen aan de objectdefinitie New Application:

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{    "name": "New Application",    "object_properties": [],    "related_boem": [        {            "id": "58edcaf2829327621cecc9e5"        },        {            "id": "6409d89638102b8f57cece3e"        }    ]}'

Een geldig verzoek geeft een response met een 202 Accepted HTTP-statuscode en de volgende body terug:

{    "result": "OK"}

Een objectvragenlijst verwijderen

Je kunt een objectvragenlijst verwijderen door een call te doen naar de endpoint PUT /object-definitions/{id}. Voor een succesvolle call geef je het volgende op:

Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door de ID van de objectdefinitie waarvan je een vragenlijst wilt verwijderen.
De header voor je API-verzoek
De request body die alle parameters moet bevatten die je wilt behouden in het vervangende bedrijfsmiddel

Hieronder vind je een voorbeeld van een API-verzoek om de bestaande objectvragenlijst Application Questionnaire te verwijderen uit de objectdefinitie New Application. In het vorige voorbeeld zijn twee vragenlijsten toegevoegd en hier verwijderen we er één.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{    "name": "New Application",    "object_properties": [],    "related_boem": [        {            "id": "58edcaf2829327621cecc9e5"        }    ]}'

Een geldig verzoek geeft een response met een 202 Accepted HTTP-statuscode en de volgende body terug:

{    "result": "OK"}

Een objecteigenschap toevoegen

Om een nieuwe eigenschap toe te voegen aan een objectdefinitie, doe je een PUT-verzoek naar de /object-definitions/{id} endpoint met daarin:

Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door de ID van de objectdefinitie waaraan je een eigenschap wilt toevoegen.
De header voor je API-verzoek
De request body die alle parameters moet bevatten die je wilt behouden in het vervangende bedrijfsmiddel

Het onderstaande voorbeeld toont een API-verzoek om een nieuwe objecteigenschap met de name Supplier en de standaard value Microsoft toe te voegen aan de objectdefinitie New Application.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{    "name": "New Application",    "object_properties": [        {            "name": "Supplier",            "value": "Microsoft"        }    ],    "related_boem": [        {            "id": "58edcaf2829327621cecc9e5"        }    ]}'

Een geldig verzoek geeft een response met een 202 Accepted HTTP-statuscode en de volgende body terug:

{    "result": "OK"}

Een objecteigenschap bijwerken

Hier beschrijven we de stappen om een bestaande objecteigenschap bij te werken. Om deze actie uit te voeren, doe je een PUT-verzoek naar de /object-definitions/{id} endpoint met daarin:

Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door de ID van de objectdefinitie waarvoor je een eigenschap wilt bijwerken.
De header voor je API-verzoek
De request body die alle parameters moet bevatten die je wilt behouden in het vervangende bedrijfsmiddel

Het onderstaande voorbeeld toont een API-verzoek om de objecteigenschap met de name Supplier en de standaard value Microsoft bij te werken op de objectdefinitie New Application. In dit voorbeeld wijzigen we de standaard value van de eigenschap van Microsoft naar AWS.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{    "name": "New Application",    "object_properties": [        {            "name": "Supplier",            "value": "AWS"        }    ],    "related_boem": [       {            "id": "58edcaf2829327621cecc9e5"        }    ]}'

Een geldige aanvraag geeft een antwoord met een 202 Accepted HTTP-statuscode en de volgende body:

{    "result": "OK"}

Verwijder een objecteigenschap

In deze sectie beschrijven we de stappen om een bestaande objecteigenschap te verwijderen. Om deze actie uit te voeren, doe je een PUT-aanvraag naar het /object-definitions/{id} endpoint en geef je het volgende op:

Bedrijfsmiddel/endpoint bestemmings-URL. Vervang de padparameter {id} door het ID van de objectdefinitie waarvan je een eigenschap wilt verwijderen.
De header voor je API-aanvraag
De request body, waarin je alle parameters opneemt die je wilt behouden in het aangepaste bedrijfsmiddel

Het onderstaande voorbeeld laat een voorbeeld van een API-aanvraag zien om de objecteigenschap met de naam Supplier en de standaard waarde AWS uit de objectdefinitie Nieuw Application te verwijderen.

curl -L -X PUT 'https://public-api.eu.bluedolphin.app/v1/object-definitions/640b3d7d4a28b925fcf8b9a2' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{    "name": "Nieuw Application",    "object_properties": [ ],    "related_boem": [        {            "id": "58edcaf2829327621cecc9e5"        }    ]}'

Een geldige aanvraag geeft een antwoord met een 202 Accepted HTTP-statuscode en de volgende body:

{    "result": "OK"}

Een objectdefinitie bijwerken

HTTP-responses

Voorwaarden

Objectdefinitie hernoemen

Een objectvragenlijst toevoegen

Een objectvragenlijst verwijderen

Een objecteigenschap toevoegen

Een objecteigenschap bijwerken

Verwijder een objecteigenschap