Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
In deze sectie vind je de stappen om een bestaande objectdefinitie te verwijderen. Gebruik deze endpoint wanneer een van de definities in het conventiemodel overbodig is geworden en uit de repository verwijderd moet worden. Als je een objectdefinitie verwijdert, worden alle objecten die op deze definitie zijn gebaseerd permanent uit de database verwijderd, maar niet uit de werksets.
Het is alleen mogelijk om uitgeschakelde objectdefinities te verwijderen. Wil je een ingeschakelde objectdefinitie verwijderen, dan moet je deze eerst uitschakelen via de endpoint object-definitions/{id}/disable.
LET OP: Als een datamodule is ingeschakeld, zijn Bedrijfsobject en Data Objecten vergrendelde definities en kunnen ze niet worden verwijderd.
HTTP-responses
HTTP response status code | Interpretatie |
200 OK | Objectdefinitie succesvol verwijderd |
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
400 Bad Request | Er zijn één of meer validatiefouten opgetreden:
|
403 Forbidden | De gebruiker mag deze objectdefinitie niet verwijderen |
Om een bestaande objectdefinitie te verwijderen, doe je een DELETE-verzoek naar de /object-definitions/{id} endpoint met daarin:
Resource/endpoint bestemmings-URL. Vervang de padparameter {id} door het ID van de objectdefinitie die je uit de repository wilt verwijderen.
De header voor je API-verzoek
Om de objectdefinitie met de naam Nieuwe Applicatie en id 64a42dc72539a230838f9d22 te verwijderen, sturen we een DELETE-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/object-definitions/64a42dc72539a230838f9d22.
curl -L -X DELETE 'https://public-api.eu.bluedolphin.app/v1/object-definitions/64a42dc72539a230838f9d22' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json'
Een geslaagde call geeft een response terug met een 200 OK HTTP-statuscode en de volgende body:
{ "result": "OK"}