Atlassian
GovernanceHow to ensure API governance (advertise, consistency, …)
|
Updates and VersioningHow to handle API updates and versioning |
PaginationHow to retrieve a range of resources in a collection
|
CollectionWhat is a collection (set) of resources
|
Data formatwhich data format use
|
DELETEThe DELETE method deletes the specified resource. |
PUTThe PUT method requests that the enclosed entity be stored under the supplied URI. If the URI refers to an already existing resource, it is modified; if the URI does not point to an existing resource, then the server can create the resource with that URI. |
CachingHow to use and provide relevant caching informations
|
HTTP HeadersHow to use standard or custom HTTP headers
|
HTTP StatusesGeneral information about HTTP statuses usage |
301 Moved PermanentlyThis and all future requests should be directed to the given URI. |
304 Not ModifiedIndicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy. |
200 OKStandard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
201 CreatedThe request has been fulfilled, resulting in the creation of a new resource. |
202 AcceptedThe request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. |
204 No ContentThe server successfully processed the request and is not returning any content. |
401 UnauthorizedSimilar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. |
404 Not FoundThe requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. |
412 Precondition FailedThe server does not meet one of the preconditions that the requester put on the request. |
Hypermedia (read)How to use hypermedia to read data
|
Hypermedia (write)How to use hypermedia to write data
|
HypermediaHow to use hypermedia
|
Delete resourceHow to delete resources |
Dereference RelationshipsHow to load a resource and its linked resources in one call
|
Update resourceHow to update a resource |
URL formatHow to design URLs
|
ResourceGeneral informations about resources |