Show/Hide Toolbars

TMS XData Documentation

Navigation: Data Modification

Delete an Entity

Scroll Prev Top Next More

To delete an entity, clients must perform a DELETE request to a single entity URL address. The request body must be empty. The entity represented by that address will be removed from server.

 

The following example will delete the entity resource at address /tms/xdata/TDog(1) - which is a Dog entity with id equals to 1:

 

DELETE /tms/xdata/Dog(1) HTTP/1.1
Host: server:2001

 

Note that depending on cascades configured in the server, associated entities might also be removed. If the entity being removed is associated by another entity that can't be removed in a cascade operation, a constraint enforcement will fail and the server will return an error without actually removing the entity.

 

On successful delete, the server responds with a 204 No Content response and no content in message payload.