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:53:53 +01:00
parent 27a5faa4ee
commit 3650bdaa04
2 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
execution/asynchronous-tasks.md
View File

@@ -1,9 +1,9 @@
# 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 Resource
The task resource **SHOULD** convey the information about the status of the asynchronous task.
## Task Tracking Resource
The task-tracking resource **SHOULD** convey the information about the status of an asynchronous task.
Retrieval of such a resource using the HTTP GET Request Method **SHOULD** be designed as follows: