Delete Entities

The Entities API finally allows you to delete entities that should be removed from the application. The corresponding endpoint is once again: /entities/:entityName/:entityId using the HTTP method DELETE.

The following example removes a previously created Customer:

Request
DELETE http://localhost:8080/rest
            /entities
            /sample_Customer
            /13f01f59-8e5f-4fd9-802b-66501d49ac99

In case the entity exists, the response status 200 - OK is returned without any response body, and the entity is deleted from the application. In case the entity is not found, 404 - Not Found is returned.

The Entities API takes Soft Deletion into consideration. Depending on the setting of the entity, the instance is either only soft-deleted or deleted entirely from the database.

Bulk Delete

The Delete-Entity API also allows you to delete multiple entities within one request. For this the JSON request body should contain an array of IDs representing each entity.

Bulk Update Request
DELETE http://localhost:8080/rest
            /entities
            /sample_Customer

[
  "3b9a1d43-1397-d2ae-eedd-f79eec1b81e2",
  "20ba4218-6690-c14c-9453-9ccd4b0add37"
]

In case all entities could be deleted, the HTTP response code 200 - OK is returned.