Response codes
The Lenovo XClarity Orchestrator REST APIs use the HTTP protocol for sending and retrieving data. Client code using the REST APIs makes an HTTP request to the XClarity Orchestrator server and processes the HTTP response accordingly. Included with the HTTP response data is the HTTP status code. The status code provides some indication as to the success of the HTTP request and can provide information about how to handle the included response data.
The following table lists some of the most common response codes.
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. If a single query parameter is specified and the value of that parameter has no matches, the response body returns default values. If a list of query parameters is specified and the value of at least one parameter has no matches, the response body returns only what matches. |
| 201 | Created | One or more new resources were successfully created. |
| 202 | Accepted | The request has been accepted for processing, but the processing has not yet completed. The request might or might not be acted upon, depending on the results of the processing. |
| 204 | No Content | The request completed successfully, but no response content is returned (for example, a successful DELETE request). |
| 205 | Reset Content | One or more new resources were successfully replaced. |
| 206 | Partial Content | Partial content was returned for a multi-part response. The response header includes a content-range header field indicating the range that is included in the response body for each part. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. For GET requests, this code is returned when the user session is expired because the web inactivity session time-out expired or the mandatory session expiration time was exceeded. You must log in again to view data. For information about session time-outs, see Configuring user security settings. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. |
| 404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
| 405 | Method Not Allowed | The resource is invalid. A descriptive error message is returned in the response body. |
| 406 | Not Acceptable | The request cannot be fulfilled. A descriptive error message is returned in the response body. POST, PUT, PATCH, and DELETE requests return 406 when the user session is expired because the Web inactivity session for full operations timeout expired or the mandatory session expiration time was exceeded. You must log in again to modify data. For information about session timeouts, see Configuring user security settings. |
| 408 | Request Timeout | The orchestrator server did not receive a required request in a specific amount of time. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 410 | Gone | The resource no longer available. A descriptive error message is returned in the response body. |
| 413 | Request Entity Too Large | Clients might impose limitations on the length of the request URI, and the request URI is too long to be handled. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |