General List API Errors

For any list query, the following errors may occur depending on the executed query.

Occasion	Return code	Message
Misspelled / unqualified field	400 (Bad request)	The field list "<Field List>" could not be interpreted: Error 1 (e.g. ArticleLang.DescriptionShort / ArticleLang.DescriptionShort() -> unqualified) Error 2 (e.g. ArticleLang.DescriptionShort(de, en, 123) -> Invalid qualification) Error 3 (e.g. ...)
Invalid entity	404 (Not found)	Entity '<entity identifier>' does not exist
Entity is no root entity	404 (Not found)	Entity '<entity identifier>' is not a root entity.
Report/Search not found	404 (Not found)	Report '<report name>' does not exist
Any other unexpected error	500 (internal server error)	The response body will contain the error message of the original exception as plain text without stack trace in this case The stack trace of the exception is logged on the server

Report Specific Errors

If the result of a predefined report is requested, the following errors may occur additionally to the General Errors of the List API.

Occasion	Return code	Message
Missing report parameters	400 (Bad request)	The following mandatory report parameters have not been provided: A, B, C
Invalid values for report parameters	400 (Bad request)	If paramter value could not be converted: "Value of given parameter X has a wrong format" If proxy does not exist: "Given item for parameter X does not exist"
Missing report	404 (Not found)	Report '<ReportName>' does not exist.

If a search query is performed using the search query language, the following errors may happen in addition to the General Errors of the List API.

Occasion

Return code

Message

Invalid query syntax

400 (Bad request)

Search Query syntax is incorrect

Example:

Unexpected character found at position 11

a = 1 AND b / 2
^

No search available

404 (Resource not found)