DELETE: Delete a collection

This topic provides instructions for using the DELETE operation to delete multiple entities.

Overview

When performing the DELETE operation, consider the following points:

  • A request for a delete on a collection deletes the entire collection.
  • Deleting can be done using filtering.
  • Supports partial success, similar to POST and PUT.
  • You can delete up to 5,000 entities through a single request.

  • On success, only status code 200 (OK) is returned.

Caution: It is possible to delete all of the instances in a collection if no query is specified. For example, the following line will delete all defects in the project:

DELETE .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects

If your site has been configured to be compliant with the GDPR 'Right to erasure (right to be forgotten)' regulation, the deletion of a collection is not supported.

Back to top

Examples

This example deletes all defects.

DELETE .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/ 

*** Response ***
HTTP/1.1 200 OK

Back to top

See also: