Delete an object definition

This section provides the steps for deleting an existing object definition. You should use this endpoint whenever one of the definitions in the convention model becomes redundant and its removal from the repository is required. If you remove an object definition, all objects that are based on this definition will be permanently deleted from the database, but not from the views.

It is only possible to delete disabled object definitions. If you want to delete an enabled object definition, you have to disable it first using the endpoint object-definitions/{id}/disable.

Note: Business Object and Data Object are locked object definitions and cannot be deleted.

HTTP responses

To delete an existing object definition, make a DELETE request to the /object-definitions/{id} endpoint specifying:

• Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition that you want to remove from the repository.

• The header for your API request

To delete the object definition of the name New Application and id 64a42dc72539a230838f9d22, we pass a DELETE request to the 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'

A successful call returns a response with a 200 OK HTTP status code and the following body:

{
    "result": "OK"
}