Receiving output from server

Output is returned from the server in these ways:

Response header

All supported output header fields follow the HTTP/1.1 protocol. For a list describing HTTP/1.1 header definitions, see Header Field Definitions. Below you can find a list of ALM Octane-supported response header fields:

Header Name

Mandatory

  • Functionality
  • Example

    Content-Encoding

    Y

    • Specifies which coding was applied on the response body.

    • Return coding must be a sub-list of the coding specified in the Accept-Encoding request header.

    Content-Encoding: gzip

    Content-Type

    Y

    • Specifies the media type that is being used for the response body.

    • Return media types must be a sub-list of the media types specified in the Accept request header.

    Content-Type: application/json;q=0.9

    Date

    Y

    • Specifies the date and time at which the message was originated.

    • Date and time format follow the guidelines provided in RFC 1123.

    Exception: Date response header might be omitted by the server when the following status code return: 100, 101, 500, 503

    Date: Mon, 24 Mar 2014 12:11:05 GMT

    Server

    Y

    • Specifies the software used by the server to handle the request.

    • Forward proxies must not change this response header and must use the Via response header instead.

    Server: Jetty

    Via

    N

    • Specifies the proxy or gateway software that forwarded the request to the server.

    Via: server.com (Apache/2.1)

    Response body

    By default, only the JSON representation is supported for all resource instances and resource collections.

    JSON representations follow the ECMA-404 standard called "The JSON Data Interchange Format.”

    Back to top

    See also: