-
Notifications
You must be signed in to change notification settings - Fork 152
Bulk operations Types
There are multiple types of bulk operations that we consider here:
- bulk creation
- bulk update
- bulk operation with both creates and updates
For all of these, the idea is that a POST is performed against a collection resource, with a collection of items (see example in the next section).
For each item, the REST API must identify whether it should be created or updated.
The distinction is easily made because:
- for a creation, the provided item does not have an ID
- for an update, the provided item does have an ID
Only implement this if you ABSOLUTELY require it. Bulk deletion is a dangerous operation
Rules for the server:
- SHOULD return HTTP 204 (No Content) if the delete operation is immediate
- SHOULD return HTTP 202 (Accepted) if the delete operation is NOT immediate
This project is distributed under the terms of the EUPL FOSS license
REST Resources Design Workflow
REST Resources Single items and collections
REST Resources Many to many Relations
REST Resources Relations expansion
HTTP Status Codes Success (2xx)
HTTP Status Codes Redirection (3xx)
HTTP Status Codes Client Error (4xx)
HTTP Status Codes Server Error (5xx)
Pagination Out of range/bounds
Long-running Operations Example
Concurrency vs Delete operation
Caching and conditional requests About
Caching and conditional requests Rules
Caching and conditional requests HTTP headers
Error handling Example with a single error
Error handling Example with multiple errors
Error handling Example with parameters
Error handling Example with additional metadata
Bulk operations HTTP status codes
Bulk operations Resources naming convention
Bulk operations Creation example
Bulk operations Update example
Bulk operations Create and update example
File upload Simple file upload
File upload Simple file upload example
File upload Complex file upload
File upload Complex file upload example
REST Security General recommendations
REST Security Insecure direct object references