Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates execution/asynchronous-tasks.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-22 11:50:25 +01:00
parent 9e0284a719
commit 27a5faa4ee
1 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
execution/asynchronous-tasks.md
View File

@@ -1,2 +1,20 @@
# Asynchronous Tasks
If an API operation is asynchronous, but its progress could be tracked by a client the response to such an operation MUST return the
If an API operation is asynchronous, but its progress could be tracked by a client, the response to such an asynchronous operation **MUST** return, in the case of success, the **202 Accepted** status code together with a `application/hal+json` representation of a new task-tracking resource.
## Task Resource
The task resource **SHOULD** convey the information about the status of the asynchronous task.
Retrieval of such a resource using the HTTP GET Request Method **SHOULD** be designed as follows:
1. Task is Still Processing
Return **200 OK** and representation of the current status.
2. Task Successfully Completed
Return **303 See Other** together with [HTTP Location Header](https://tools.ietf.org/html/rfc7231#section-7.1.2) with URI or a outcome resource.
3. Task Failed
Return **200 OK** and `application/problem+json` with the problem detail information on the task has failed.