Delete multiple records using REST

by
  1. Is a viable RESTful choice, but obviously has the limitations you have described.
  2. Don’t do this. It would be construed by intermediaries as meaning “DELETE the (single) resource at /records/1;2;3” — So a 2xx response to this may cause them to purge their cache of /records/1;2;3; not purge /records/1, /records/2 or /records/3; proxy a 410 response for /records/1;2;3, or other things that don’t make sense from your point of view.
  3. This choice is best, and can be done RESTfully. If you are creating an API and you want to allow mass changes to resources, you can use REST to do it, but exactly how is not immediately obvious to many. One method is to create a ‘change request’ resource (e.g. by POSTing a body such as records=[1,2,3] to /delete-requests) and poll the created resource (specified by the Location header of the response) to find out if your request has been accepted, rejected, is in progress or has completed. This is useful for long-running operations. Another way is to send a PATCH request to the list resource, /records, the body of which contains a list of resources and actions to perform on those resources (in whatever format you want to support). This is useful for quick operations where the response code for the request can indicate the outcome of the operation.

Everything can be achieved whilst keeping within the constraints of REST, and usually the answer is to make the “problem” into a resource, and give it a URL.
So, batch operations, such as delete here, or POSTing multiple items to a list, or making the same edit to a swathe of resources, can all be handled by creating a “batch operations” list and POSTing your new operation to it.

Don’t forget, REST isn’t the only way to solve any problem. “REST” is just an architectural style and you don’t have to adhere to it (but you lose certain benefits of the internet if you don’t). I suggest you look down this list of HTTP API architectures and pick the one that suits you. Just make yourself aware of what you lose out on if you choose another architecture, and make an informed decision based on your use case.

There are some bad answers to this question on Patterns for handling batch operations in REST web services? which have far too many upvotes, but ought to be read too.

More Related Contents:

  1. What are best practices for REST nested resources?
  2. What is the proper REST response code for a valid request but an empty data?
  3. When do I use path params vs. query params in a RESTful API?
  4. API pagination best practices
  5. Call a Server-side Method on a Resource in a RESTful Way
  6. What exactly is RESTful programming?
  7. Best practices for API versioning? [closed]
  8. If REST applications are supposed to be stateless, how do you manage sessions?
  9. Free Rest API to retrieve current datetime as string (timezone irrelevant) [closed]
  10. Design RESTful query API with a long list of query parameters [closed]
  11. Transactions in REST?
  12. How to QUEUE a new build using VSTS REST API
  13. What is RESTful programming?
  14. How to understand “RESTful API is stateless”?
  15. RESTful way to create multiple items in one request
  16. Querystring in REST Resource url
  17. Why the slow WADL uptake? [closed]
  18. REST vs JSON-RPC? [closed]
  19. Azure Websites Kudu REST API – Authentication
  20. REST api: requesting multiple resources in a single get [duplicate]
  21. How to format Swagger 2.0 text descriptions?
  22. Update an entire resource collection in a REST way
  23. How should the header X-DocuSign-Authentication be used for REST and SOAP?
  24. How to create new build pipeline using Azure DevOps REST API?
  25. Restful way for deleting a bunch of items
  26. Swagger documentation with JAX-RS Jersey 2 and Grizzly
  27. How one could use server side sorting and paging with Azure Mobile Services
  28. How to do a PUT request with cURL?
  29. What REST PUT/POST/DELETE calls should return by a convention?
  30. Get/post to RESTful web service

Leave a Comment