Error and response codes
The REST API returns two levels of error information:
- HTTP status codes and messages in the header.
- A JSON object in the response body with additional details. See Error response objects for more information.
| Status code | Text | Explanation |
|---|---|---|
| 200 | Success | The request was successful. The response returned is unique to the specific request. |
| 201 | Success (created item) | The request to create an item was successful. The response returned is unique to the specific request. |
| 204 | Success (updated item) | The request to update an item was successful. No additional information is returned. |
| 206 | Partial Success | The request was partially successful. The response returned is unique to the specific request. |
| 400 | Bad Request | The request is missing or contains invalid information, such as required parameter. |
| 401 | Unauthorized | Access is denied. The username/password or access token is not recognized. |
| 403 | Forbidden | The user does not have access to perform the action. This could be because the user does not have a valid Helix ALM license, is not in the requested project, does not have the 'Allow Login Via SOAP' command enabled in their security group, or does not have the required security commands to perform the action enabled in their security group. |
| 404 | Not Found | The requested record was not found |
| 409 | Conflict | A conflict occurred, such as the record is locked by another user or the project is locked by an administrator. |
| 429 | Too Many Requests | The user sent too many requests within the rate limiting timeframe. |
| 500 | Internal Server Error | Default error code. Check the message property in the error response for details. |
| 503 | Service Unavailable | The REST API Server is currently unavailable or busy. This could be caused by throttling or a 'Helix ALM Server is busy' cache lock error. |