Share this page

# Receiving responses

This section provides instructions for receiving responses from the ALM Octane server.

In this topic:

## Overview

Output is returned from the server in these ways:

- Status codes. See Errors and status codes.

- Response header. See Response header.

- Response body. See Response body.

Back to top

## 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 | Functionality
--- | ---
Content-Encoding | 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. Mandatory. Example: Content-Encoding: gzip
Content-Type | 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. Mandatory. Example: Content-Type: application/json;q=0.9
Date | 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 Mandatory. Example: Date: Mon, 24 Mar 2014 12:11:05 GMT
Server | 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. Example: Server: Jetty
Via | Specifies the proxy or gateway software that forwarded the request to the server. Optional. Example: Via: server.com (Apache/2.1)

Back to top

## 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

Response bodies for GET operations

Responses for GET operations generally include:

- The relevant ID and type fields, and other default fields. To see additional fields, see Select fields (fields).

- A total_count of items returned by the GET operation.

  You can set the maximum number of items that can be returned using the MAX_PAGE_SIZE configuration parameter. For details, see Setting configuration parameters with the REST API.

- An exceeds_total_count value indicates if the maximum number of items that can be returned by the GET operation has been reached. If the value is true, the GET response is partial.

A GET response

    {
        "total_count": 2,
        "data": [
            {
                "type": "defect",
                "id": "1014"
            },
            {
                "type": "defect"
                "id": "1012"
            }
        ],
        "exceeds_total_count": false
    }

Back to top

Response bodies for PUT, POST, and DELETE operations

Responses for GET operations generally include:

- The relevant ID and type fields. To see additional fields, see Select fields (fields).

- A total_count of items returned by the GET operation.

- A business_error value might be included if an error is returned, and the error is of a business nature, such as a duplicate name, or an entity failing rule validation.

A POST response that shows an error

    {
        "total_count": 2,
        "data": [
            ...

            ...

            ...

        ],
        "exceeds_total_count": false

    "errors": [
        {
          "error_code": "platform.duplicate_entity_error",
          "correlation_id": "gxwk4vw6l51k2bp30z6r6o5yd",
          "description": "A release with this name already exists.",
          "description_translated": "A release with this name already exists.",
          "properties": {
            "entity_type": "release",

           "message": "service=[CreateServiceImpl],
                       blFlowCommand=[BinaryEntitiesWriter],
                       token=[ReleaseEntityToken] has thrown an exception and
                       terminated BL flow. See service result log message for details.
                       Error=[Failed to add data to DB due to unique
                       constraint violation with the following field names:
                      [name, workspace_id] for release entity.]",

            "field_name": "name"
          },
          "stack_trace": "",
          "business_error": true
        }
      ]

    }

Back to top

See also:

- Performing requests

https://admhelp.microfocus.com ALM Octane 8942
Tips to improve your search results... ALM Octane Help Center ALM Octane Help 15.1.90 All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: