-
Notifications
You must be signed in to change notification settings - Fork 152
Bulk operations Non atomic
You SHOULD:
- return a 200 (ok) status code if all went well (same as for automic bulk operations)
- return a 4xx status code with errors (including the index property) if an error occurred with one or more of the elements
- you SHOULD return errors for all items for which there was an issue, including the index property (see errors section below)
- your API client MUST be aware of the non-atomic property of the resource and of the fact that any item not listed in the errors object returned was processed
You MAY combine the representation of errors and of collections to provide a complete response to your API client in case of a partial failure.
To be clear, let's assume that your client has POSTed 20 items and that there were errors for two of those. Your response look like this:
HTTP/1.1 400
{
"items": [
{ ... }
],
"errors": [
{ ... }
]
}
So basically:
- all items that were successfully created/updated can be provided in the items array
- all errors that were raised can be appended to the errors array
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