API Status and Error Codes
Learn about Visier API call status codes and errors.
Status codes
Visier uses standard HTTP response codes to inform you of the success or failure of an API request.
Codes are grouped into several categories, summarized in the following list:
- 2xx: A successful API request.
- 4xx: An error occurred due to the provided request parameters.
- 5xx: An error occurred with Visier’s servers.
The following table describes each of the possible codes.
|
Code |
Description |
Notes |
|---|---|---|
|
200 |
OK |
The request ran successfully. |
|
201 |
Created |
New objects created successfully, such as a new user. |
|
204 |
No Content |
The server successfully fulfilled the request and there is no additional content to send in the response. |
|
207 |
Multi-Status |
The message body may contain a number of separate response codes, depending on how many sub-requests were made. |
|
400 |
Bad Request |
The API request failed given the parameters provided, such as missing or invalid parameters. |
|
401 |
Unauthorized |
The API request failed because the authentication credentials expired. |
|
403 |
Forbidden |
The user made a request to the API, but is prohibited from running it successfully, such as due to insufficient privileges. For more information about API users, see Studio Profiles. |
|
404 |
Not Found |
The user made a request to the API for a method or resource that does not exist. |
|
406 |
Not Acceptable |
The request content is not acceptable according to the Accept header. This error is common in the Data Query API if the user doesn't include application/json after text/csv in the Accept header. |
|
429 |
Too Many Requests |
API rate limit exceeded. |
|
500 |
Internal Server Error |
An unexpected exception occurred on the server. |
|
501 |
Not Implemented |
The request failed due to using an unimplemented feature. |
|
502 |
Bad Gateway |
An unexpected exception occurred on the server. |
|
504 |
Gateway Timeout |
The server is taking too long to respond and the request timed out. |
Errors
If an error occurs, more detail is available in the response payload. For any unexpected issues, please quote the RCI code and localized message when contacting Visier Support.
The value associated with the message key indicates the nature of the error. Ensure that common issues are managed within your code.
Response
|
Element |
Description |
Type |
|---|---|---|
|
errorCode |
A brief identifier of the type of error. |
string |
|
message |
The details of the error. |
string |
|
rci |
A root cause identifier that allows Visier to determine the source of the problem. |
string |
Sample response
In this example, the error indicates that the query is invalid due to unspecified time intervals. To fix this error, determine the appropriate time interval and take the appropriate corrective action.
{
"errorCode": "DSE_INVALID_QUERY_DEFINITION",
"message": "Aggregation query definition not valid: time intervals not specified.",
"rci": "DS0000027"
}