The REST API uses the following standard HTTP status codes to indicate the processing results.
HTTP status codes |
Description |
---|---|
200 |
OK The request was processed correctly. |
202 |
Accepted The request for asynchronous processing was accepted. |
400 |
Bad Request The request header, the query parameter, the object ID, or the request body is invalid. |
401 |
Unauthorized The Authorization header is not specified in the request header. Alternatively, authentication by using the information specified in the Authorization header fails. |
403 |
Forbidden You do not have the permission required to perform the operation. |
404 |
Not Found The resource specified by the URL could not be found. Alternatively, there are no resources for the specified URL. |
406 |
Not acceptable The media type specified in the Accept header is not supported. |
415 |
Unsupported Media Type The specified media type is not supported. |
500 |
Internal Server Error An internal error occurred on the server. Only the most critical error is returned. If an API function for operating multiple resources is run, and if partial information is obtained or if part of the operation is successful, the following attribute appears: partialSuccessResponses The displayed content differs depending on the type of HTTP method that was used:
|
503 |
Service Unavailable Indicates that the service is temporarily unavailable because it is busy or under maintenance. Only the most critical error is returned. If the response header includes Retry-After, wait for the period of time indicated by the return value (the recommended wait time, given in seconds), and then run the request again. If an API function for operating multiple resources is run, and if partial information is obtained or if part of the operation is successful, the following attribute appears: partialSuccessResponses The displayed content differs depending on the type of HTTP method that was used:
|
504 |
Gateway Timeout No response was received from the device in the allotted time. Only the most critical error is returned. If an API function for operating multiple resources is run, and if partial information is obtained or if part of the operation is successful, the following attribute appears: partialSuccessResponses The displayed content differs depending on the type of HTTP method that was used:
|