Intelligence API Error Catalog

This section documents the errors that Intelligence APIs may return.

Authentication & Authorization Errors

Returned when Response
Status code Example
Request does not provide a Bearer token. 401
{"error": "Unauthorized"}
The Bearer token is passed but is empty or follows an invalid format. 401
Invalid "Authorization" header format. 
Should start either with "Bearer " or "AppKey " (case insensitive).
The user does not have permission to access a specific Knowledge Model. 403
{
   "title": "Access Denied.",
   "status": 403,
   "detail": "Access is denied",
   "errorCode": "ADMIN_ACCESS_ERROR"
}
Intelligence APIs is disabled 403
EMPTY BODY

Common Errors

Returned when Response
Status code Example
Sending an invalid format as part of the page parameter. 400
{
   "title": "Query parameter type mismatch.",
   "status": 400,
   "detail": "Query parameter 'page' must be of type 'Integer'.",
   "errorCode": "GENERAL_PARAMETER_MISSMATCH"
}
Sending an invalid format as part of the pageSize parameter. 400
{
   "title": "Query parameter type mismatch.",
   "status": 400,
   "detail": "Query parameter 'pageSize' must be of type 'Integer'.",
   "errorCode": "GENERAL_PARAMETER_MISSMATCH"
}
Requesting a non-existing path. 404
{
   "title": "Path not found.",
   "status": 404,
   "detail": "Path /intelligence/api/knowledge-models not found",
   "errorCode": "GENERAL_NOTFOUND_PATH"
}
Unexpected server-side error. 500
{
   "title": "Unexpected error.",
   "status": 500,
   "detail": "Something went wrong while handling the request. Please contact Celonis customer support. Celonis Support ID: 671d3bdc-9feb-45ff-b367-7b47470d4680",
   "errorCode": "ADMIN_FATAL_ERROR"
}
Rate limit has been exceeded. 429
{
   "title": "Rate limit exceeded",
   "status": 429,
   "detail": "Rate limit for INTELLIGENCE_API_RATE_LIMIT is exceeded. Please try again at 06:10:41 UTC.",
   "errorCode": "LIMIT_RATE_EXCEEDED"
}
Rate limit is not found for the size defition. 404
{
   "title": "Limit MAX_REQUESTS not found.",
   "status": 404,
   "detail": "Limit MAX_REQUESTS in size L not found.",
   "errorCode": "LIMIT_SIZE_NOTFOUND"
}
Rate limit is not properly configured. 404
{
   "title": "Limit MAX_REQUESTS not found.",
   "status": 404,
   "detail": "Limit MAX_REQUESTS not properly configured.",
   "errorCode": "LIMIT_NOTFOUND"
}

Schema Endpoints Errors

Returned when Response
Status code Example
Requesting a non-existing field in the sort parameter. 400
{
   "title": "Some fields in sort don't exist in fields.",
   "status": 400,
   "detail": "This field doesn't exist names",
   "errorCode": "SORT_UNKNOWN_FIELD"
}
Sending, as part of the sort parameter, the same field with opposite sorting criterias. 400
{
   "title": "Some sort fields have duplicated fields.",
   "status": 400,
   "detail": "Sort parameter contains duplicate fields with opposite sorting directions: testField.",
   "errorCode": "SORT_HAS_OPPOSITE"
}
Sending an empty sort parameter. 400
{
   "title": "Sort parameter error length.",
   "status": 400,
   "detail": "Sort parameter should not be empty.",
   "errorCode": "SORT_IS_EMPTY"
}
Referencing a non-existing Knowledge Model. 404
{
   "title": "Knowledge Model not found.",
   "status": 404,
   "detail": "Knowledge Model with id 'XXXX' was not found.",
   "errorCode": "KM_MODEL_NOTFOUND"
}
Referencing a non-existing record. 404
{
   "title": "Record not found.",
   "status": 404,
   "detail": "The record Id: XXXX wasn't found",
   "errorCode": "KM_RECORD_NOTFOUND"
}

Data Endpoint Errors

Returned when Response
Status code Example
Not sending the fields parameter. 400
{
   "title": "Missing parameters.",
   "status": 400,
   "detail": "Required request parameter 'fields' for method parameter type List is not present",
   "errorCode": "GENERAL_PARAMETER_MISSING"
}
Passing an empty fields parameter. 400
{
   "title": "Some params have constraint violations.",
   "status": 400,
   "detail": "[fields: size must be between 1 and 200]",
   "errorCode": "GENERAL_CONSTRAINT_VIOLATION"
}
Requesting a non-existing field as part of the fields parameter. 400
{
   "title": "Field not found.",
   "status": 400,
   "detail": "Fields not found: test. Note: Fields are case sensitive.",
   "errorCode": "KM_FIELD_NOTFOUND"
}
Requesting a non-existing field in the sort parameter. 400
{
   "title": "Unknown sorting fields",
   "status": 400,
   "detail": "These fields don't exist at the given record [test].",
   "errorCode": "SORT_UNKNOWN_FIELD"
}
Referencing a non-existing filter as part of the filters parameter. 404
{
   "title": "Filter not found.",
   "status": 404,
   "detail": "Filter not Found: name.",
   "errorCode": "FILTERS_FILTER_NOTFOUND"
}
Using a non-filterable field in the filterExpr parameter. 400
{
   "title": "Field not filterable.",
   "status": 400,
   "detail": "Field not filterable: mykpi",
   "errorCode": "FILTERS_FIELD_UNFILTERABLE"
}
Using an invalid expression as part of the filterExpr parameter. 400
{
   "title": "Invalid expression structure.",
   "status": 400,
   "detail": "Invalid expression structure: mykpi eq",
   "errorCode": "FILTERS_EXPRESSION_ILLEGAL"
}
Using an invalid operator for the filterExpr parameter. 400
{
   "title": "Invalid expression Operator.",
   "status": 400,
   "detail": "Invalid expression Operator: sq",
   "errorCode": "FILTERS_OPERATOR_ILLEGAL"
}
Using an invalid syntax for the filterExpr parameter. 400
{
   "title": Failure getting results.",
   "status": 400,
   "detail": "Syntax error found in filterExpr. Please refer to the API documentation.",
   "errorCode": "GENERAL_RESULTS_FAILURE"
}
Sending a page bigger than 19.(When using pageSize = 50) 400
{
   "title": "Some params have constraint violations.",
   "status": 400,
   "detail": "[page: value must be between 0 and 19]",
   "errorCode": "PAGE_VALUE_ILLEGAL"
}
Sending a pageSize bigger than 50. 400
{
   "title": "Some params have constraint violations.",
   "status": 400,
   "detail": "[pageSize: size must be between 1 and 50]",
   "errorCode": "PAGE_SIZE_ILLEGAL"
}
Sending special characters in the sort parameter. 400
{
   "title": "Special characters are not allowed.",
   "status": 400,
   "detail": "Some special characters were found and they are not allowed for querying.",
   "errorCode": "GENERAL_CHARS_NOTALLOWED"
}
Specifying a date in filterExpr in the wrong format. 400
   "title": "Invalid Value format.",
   "status": 400,
   "detail": "Invalid Value format: ",
   "errorCode": "GENERAL_WRONG_VALUE"
}
There’s an unexpected error as part of this request. 400
{
   "title": No data found.",
   "status": 400,
   "detail": "Error details",
   "errorCode": "GENERAL_EMPTY_DATA"
}
There’s an unexpected error as part of this request. 400
{
   "title": "Knowledge Model Field Id repeated.",
   "status": 400,
   "detail": "Knowledge Model with repeated Field Ids: [FIELD_ID]. Please fix the Knowledge Model configuration.",
   "errorCode": "KM_FIELD_ID_DUPLICATED"
   "type": "https://developer.celonis.com/intelligence-api/error-catalog/"
}