Errors and status codes

All supported status codes follow the HTTP/1.1 protocol. For a list describing HTTP/1.1 status codes, see Status Code Definitions.

Limitations: In some cases, REST API error messages are displayed in English even if ALM Octane has been localized for a specific language.

All status codes

Below you can find a list of ALM Octane supported status codes:

Code

Name

Functionality

200

OK

  • The request has succeeded

201

Created

  • The request was fulfilled

  • A new resource was created

400

Bad Request

  • The request could not be understood due to malformed syntax

  • The client is expected to perform changes in the request before re-sending

  • During a PUT or POST, additional logic restricting the field values you can set was not met. In these cases, a platform error code such as illegal_field_value is displayed with error code 400.

401

Unauthorized

  • The request requires user authentication

403

Forbidden

  • The server understood the request

  • The server refuses to fulfill it

404

Not Found

  • The server has not found a resource matching the request URI

405

Method Not Allowed

  • The request method is not allowed for the resource matching the request URI

406

Not Acceptable

  • The resource cannot be generated according to the Accept field header provided in the request

408

Request Timeout

  • HTTP protocol timeout occurred while processing the request. Handled by the servlet container

409

Conflict

  • The request was partially fulfilled or completely failed because of a conflict in the request

    If a request was partially fulfilled, and more than one entity ended in error, an index (entity_index) is returned. entity_index indicates the index of the entity in the request "data" array to which the error refers. The index starts from 0, not 1.

  • Tests: A lock prevented the ability to created a revision to a test script

415

Unsupported Media Type

  • The server understood the request

  • The request format is not supported for the request method by the resource matching the request URI

500

Internal Server Error

  • The server has encountered a condition which prevented it from fulfilling the request

501

Not Implemented

  • The server does not recognize the request method

  • The server is not capable of supporting the request method for any resource

503 Service Unavailable
  • The server is currently unable to handle the request due to maintenance of the server

 

Back to top

Logs and correlation IDs

If an error occurs while processing a request, ALM Octane sends the details to logs. Included in the details are correlation IDs. Provide the correlation IDs when contacting customer support.

{"error_code":"platform.general_error","correlation_id":"dn2wp6xe9qvgmsv8lvelp74r1","description":"General error occurred","description_translated":"General error occurred","properties":null}

Back to top