DELETE: Delete a collection

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

Overview

  • 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.
  • Supports asynchronous requests. To perform an async request, add async=true. The server will immediately return a background-task entity and will start the delete operation as a poll-able background job. The number of entities that an async request can remove is limited by the BULK_DELETE_MAX_SIZE site parameter, set to 5,000 by default. For details, see Configuration parameters.

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

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

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

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

Back to top

Examples

Back to top

See also: