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-03-15 08:11:59 +00:00
parent dea1f8662e
commit 0589770537
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
execution/asynchronous-tasks.md
View File

@@ -1,6 +1,5 @@
# Asynchronous Tasks # Asynchronous Tasks
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**. 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 Tracking Resource ## Task Tracking Resource
The task-tracking resource **SHOULD** convey the information about the status of an asynchronous task. The task-tracking resource **SHOULD** convey the information about the status of an asynchronous task.
@@ -18,3 +17,5 @@ Retrieval of such a resource using the HTTP GET Request Method **SHOULD** be des
3. Task Failed 3. Task Failed
Return **200 OK** and `application/problem+json` with the problem detail information on the task has failed. Return **200 OK** and `application/problem+json` with the problem detail information on the task has failed.