Patterns for handling batch operations in REST web services?

by

A simple RESTful pattern for batches is to make use of a collection resource. For example, to delete several messages at once.

DELETE /mail?&id=0&id=1&id=2

It’s a little more complicated to batch update partial resources, or resource attributes. That is, update each markedAsRead attribute. Basically, instead of treating the attribute as part of each resource, you treat it as a bucket into which to put resources. One example was already posted. I adjusted it a little.

POST /mail?markAsRead=true
POSTDATA: ids=[0,1,2]

Basically, you are updating the list of mail marked as read.

You can also use this for assigning several items to the same category.

POST /mail?category=junk
POSTDATA: ids=[0,1,2]

It’s obviously much more complicated to do iTunes-style batch partial updates (e.g., artist+albumTitle but not trackTitle). The bucket analogy starts to break down.

POST /mail?markAsRead=true&category=junk
POSTDATA: ids=[0,1,2]

In the long run, it’s much easier to update a single partial resource, or resource attributes. Just make use of a subresource.

POST /mail/0/markAsRead
POSTDATA: true

Alternatively, you could use parameterized resources. This is less common in REST patterns, but is allowed in the URI and HTTP specs. A semicolon divides horizontally related parameters within a resource.

Update several attributes, several resources:

POST /mail/0;1;2/markAsRead;category
POSTDATA: markAsRead=true,category=junk

Update several resources, just one attribute:

POST /mail/0;1;2/markAsRead
POSTDATA: true

Update several attributes, just one resource:

POST /mail/0/markAsRead;category
POSTDATA: markAsRead=true,category=junk

The RESTful creativity abounds.

More Related Contents:

  1. REST API error return good practices [closed]
  2. Understanding REST: Verbs, error codes, and authentication
  3. How do I upload a file with metadata using a REST web service?
  4. Secure Web Services: REST over HTTPS vs SOAP + WS-Security. Which is better? [closed]
  5. Why would one use REST instead of SOAP based services? [closed]
  6. A message body writer for Java type, class myPackage.B, and MIME media type, application/octet-stream, was not found
  7. WSDL vs REST Pros and Cons
  8. What are REST API error handling best practices? [closed]
  9. Rest vs. Soap. Has REST a better performance?
  10. REST API 404: Bad URI, or Missing Resource?
  11. Why do we need RESTful Web Services?
  12. How to secure RESTful web services?
  13. REST web service WSDL? [duplicate]
  14. Calling REST web services from a classic asp page
  15. Non-CRUD operations in a RESTful service
  16. Jersey client exception: A message body writer was not found
  17. SOAP or REST for Web Services? [closed]
  18. How to send a POST request using volley with string body?
  19. How does Google Maps secure their API Key? How to make something similar?
  20. How to access parameters in a RESTful POST method
  21. what’s the correct way to send a file from REST web service to client?
  22. Spring : File Upload RESTFUL Web Service
  23. How to consume REST in Java [duplicate]
  24. Best way to support “application/x-www-form-urlencoded” post data with WCF?
  25. Getting Unable to read WSDL error
  26. Add SOAP header object using pure JAX-WS
  27. Failed to add a service. Service metadata may not be accessible. Make sure your service is running and exposing metadata.`
  28. How to send post request to the below post method using postman rest client
  29. How to call a web service from Ant script or from within Jenkins?
  30. What is a “web service” in plain English?

Leave a Comment