Performing requests

This section provides instructions for making requests of the ALM Octane server using request headers, request bodies, and queries.

Request header

All supported input header fields follow the HTTP/1.1 protocol. You can find a list describing HTTP/1.1 header definitions Header Field Definitions. Below you can find a list of ALM Octane-supported request header fields:

Header Name


Mandatory


Functionality

Accept

No

  • The media types that the client can accept in the response.

  • An empty value or a missing header means that the client can accept all media types.

  • If the media type cannot be provided by the serve, the server should return the 406 (Not Acceptable) HTTP status code.

Accept: application/json,text/html, application/ xhtml+xml,application/xml;q=0.9, image/webp*/*;q=0.8

Accept-Encoding

No

  • Restricts the content coding that the client can accept in the response.

  • An empty value or a missing header means that the client can accept all content coding.

  • If the coding type cannot be provided by the server, the server should return the 406 (Not Acceptable) HTTP status code

Accept: Accept-Encoding: gzip,deflate,sdch

Content-Type

No

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

  • An empty value or an unknown value will be responded with a 415 (Unsupported Media Type) HTTP status code.

  • If the header is missing, the request is parsed with the web server's default setting.

Content-Type: application/json

Host

Yes

  • Represents the authority of the server or gateway the resource is requested from.

  • An empty value, an unrecognized value, or a missing header must be responded with the 400 (Bad Request) HTTP status code.

Host: <server>:<port>

Note: When sending data, always send a Content-Type header to specify the type of data being sent from the client to the server.

Do not send a Content-Type header unless content is sent.

Always send an Accept header to specify the format of the data to receive from the server.

Back to top

Request body

The API supports only application/json representation both on request and response.

Data is submitted and returned in the JSON format unless otherwise specified in the reference for a resource. This API uses the ECMA 404 Specification.

All supported request methods follow the HTTP/1.1 protocol. For a list describing HTTP/1.1 request methods, see Method Definitions.

  • GET
    Requests a representation of a resource matching the request URI.

  • PUT
    Requests that the enclosed represented resource will be stored under the matching request URI if the resource already exists.

  • DELETE
    Requests a deletion of the resource found in the matching request URI.

  • POST
    Requests a creation of a new resource under the resource collection matching the request URI.

Back to top

See also: