-
Notifications
You must be signed in to change notification settings - Fork 152
Long running Operations Flow
For long running operations, the approach to follow is to directly reply to the request with an acknowledgement and then let the client do polling to check the status of their request.
Flow:
- Request
- Response
- 202 Accepted: acknowledgement
- Location:
.../foo/bar(i.e., where to check the status/get the final response)
- Request
.../foo/bar - Response
- 202 Accepted: current status of the request (as long as it isn't completed yet)
- OR 200 OK with the data (if any)
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