Business Intelligence API Guide

The following table describes the standard HTTP status codes.

HTTP Status Code	Description
`200 OK`	The request was completed successfully. A 200 status is returned for a successful `GET` or `POST` method.
`400 Bad Request`	The request could not be processed because it contains missing or invalid information (such as a validation error on an input field or a missing required value).
`401 Unauthorized`	The request is not authorized. The authentication credentials included with this request are missing or invalid.
`403 Forbidden`	The user cannot be authenticated. The user does not have authorization to perform this request.
`404 Not Found`	The request includes a resource URI that does not exist.
`405 Method Not Allowed`	The HTTP verb specified in the request (`DELETE`, `GET`, `POST`, `PUT`) is not supported for this request URI.
`406 Not Acceptable`	The resource identified by this request is not capable of generating a representation corresponding to one of the media types in the Accept header of the request. For example, the client's Accept header request is set to XML but the operation only returns JSON.
`415 Unsupported Media Type`	The client's ContentType header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON).
`500 Internal Server Error`	The server encountered an unexpected condition that prevented it from fulfilling the request.
`503 Service Unavailable`	The server is unable to handle the request due to temporary overloading or maintenance of the server. The REST web application is not currently running.

All public-facing APIs must return the exceptionDetailType object for API errors as below:

{
"o:errorCode":33203,
"detail":"Missing required request parameters to access the resource",
"status":400,
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"VALIDATION ERROR",
"errorDetails": {[custom error object]}
}

o:errorCode numbering format for APIs

o:errorCode	API
331XX	Authentication and Authorization Errors
332XX	Validation Errors
335XX	System Errors

Authentication and Authorization

o:errorCode	Server Code (title)	HTTP Status (status)	Message (detail)	Type	Context
33101	FORBIDDEN	403	User resource not found.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3	API Account is not found.
33102	FORBIDDEN	403	Organization identifier does not match with the identity provided.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3	Organization identifier in the request URL does not match the API account's organization.
33103	INVALID CLIENT ID	401	The Client ID is invalid.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2	The Client ID provided for authorization is invalid.
33014	INVALID ACCOUNT	401	The API account details are missing or incorrect.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2	When the user provides incorrect API account username password or organization during authorization.
33015	INVALID AUTH CODE	401	The authCode is missing or incorrect.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2	The authorization code to get token is missing or incorrect.
33106	MISSING AUTH TOKEN	401	The OAuth token is missing.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2	The authentication token is not provided in the request.
33107	INVALID AUTH TOKEN	401	The OAuth token is invalid or expired.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2	The authentication token is invalid due to the following reasons Incorrect token. Token has expired. API account is inactivated.
33108	FORBIDDEN	403	You do not have permissions to access this resource.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3	The user does not have access to resource due to the following reasons API is not enabled for the enterprise. API account does not have data permissions to access this resource. API account does not have permission to access the location.
330109	RESOURCE NOT FOUND	404	Resource does not exist.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5	The user provides an invalid path to access the API.

Validate

o:errorCode	Server Code (title)	HTTP Status (status)	Message (detail)	Type	Context	errorDetails
33201	VALIDATION ERROR	400	Field is too long.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	When the request parameter field is longer than the specified length.	Contains the custom error object with parameter name which has error.
33203	VALIDATION ERROR	400	Missing required request parameters to access the resource.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	When the user does not provide the mandatory request parameters for the accessing the API.	Contains the custom object with missing parameter names.
33204	VALIDATION ERROR	400	Syntax invalid for one or more fields.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	When the user provides invalid syntax for the request parameters.	Contains the custom object with parameter names with invalid syntax.
33205	VALIDATION ERROR	400	Incorrect data type for one or more fields.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	When the user provides incorrect data type for the request parameters.	Contains the custom object with parameter names with incorrect data types.
33206	METHOD NOT ALLOWED	405	HTTP Method not allowed.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6	When the user provides the HTTP method that is not supported by the API.
33213	VALIDATION ERROR	400	Missing left parenthesis.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() when a parenthesis is missing.
33214	VALIDATION ERROR	400	Missing right parenthesis.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() when a parenthesis is missing.
33215	VALIDATION ERROR	400	Missing logical operator AND or OR.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() when multiple criteria are specified but no operator separates them.
33216	VALIDATION ERROR	400	Missing comma.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() when no comma exists between field and comparison value.
33217	VALIDATION ERROR	400	isNull does not allow comma.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() for the isNull filter type. No comparison value should be specified.
33218	VALIDATION ERROR	400	Unsupported filter name.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() when the filter name is not valid.
33219	VALIDATION ERROR	400	Unsupported field name.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1	For use with searchCriteria() when the field name is not valid.

System

o:errorCode	Server Code	HTTP Status	Message (detail)	Type	Context
33501	DB CONNECTION ERROR	500	DB connection error.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1	When the system is not able to connect to the database.
33503	SERVICE UNAVAILABLE	503	Service Unavailable.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.3	When the API service is unavailable to the user.
33599	INTERNAL SERVER ERROR	500	Internal Server Error.	https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1	When any other internal error occurs in the request processing.