Several HTTP header properties are relevant to the REST API.
Property | Description |
---|---|
Accept |
Provided by the requester and used for content negotiation to determine the response format of the request. |
Accept-Language |
Provides the data in a language that is requested. This property applies only to application fields that support multiple languages. The values that are provided (such as EN or FR) must be supported by the application. The query parameter _lang can supply the language code and provide the same capability as the Accept-Language header property. The query parameter _locale enables the numbers and dates that are returned in the locale of the requester. |
Cache-Control |
Notifies the requester whether caching is enabled. If caching is enabled, the Cache-Control property has a value of private to ensure that only the current user can reuse the content in the cache. When caching is not enabled, the Cache-Control property has a value of no-cache. The client request can contain the header Cache-Control: no-cache to disable caching for a particular request even though caching is enabled for the resource. |
Content-Length |
Contains the length of the response. |
Content-Type |
Notifies the requester of the format of the representation that is being sent. For example, the value application/xml (for XML response format) or application/json (for JSON response format) can be specified. |
ETag |
If caching is enabled, contains the Etag value for the resource that is requested. The value is held by the browser cache of the requester for subsequent requests for the same resource. |
If-None-Match |
If caching is enabled, contains the Etag value for the resource that was previously requested so that the API can determine if the cache contents can be reused. |
Last-Modified |
Notifies the requester of the date and time that the resource was last modified. |
Location |
Contains the link to a resource (HTTP code 201) that is created by an HTTP POST. |
_rlid |
Contains the ID of the resource collection and is used for in-session scrolling. |