company logo

DELETE request

In order to remove an instance from a collection or to delete it completely, the DELETE request may be used:

location - is the property source (see Symbol reference / location - HTTP URL ), which must address a single existing instance. Referring to instances via LOID is not allowed for a DELETE request.

Whether an instance is removed from the collection or deleted, depends on the ownership status of the source property. Instances in owning collections are deleted, always.

delete - In case of passing the delete parameter, an instance is completely deletes also when not being owned by the source property.

When terminating normally, DELETE returns following response:

  • deleted - when data has been deleted successfully

An error description is returned as JSON object (see Error handling ) in case of key conflicts or other error(s) in the request definition.