{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Knowledge Model API Error Catalog","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"knowledge-model-api-error-catalog","__idx":0},"children":["Knowledge Model API Error Catalog"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section documents the errors that the Knowledge Model API may return (standard error messages are described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/api-reference/common-error-catalog"},"children":["Common API Error Catalog"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"schema-endpoints-errors","__idx":1},"children":["Schema Endpoints Errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"40%","rowSpan":2,"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returned when"]}," "," "]},{"$$mdtype":"Tag","name":"th","attributes":{"colSpan":2,"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}," "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requesting a non-existing field in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some fields in sort don't exist in fields.\",\n\"status\": 400,\n\"detail\": \"The sort field does not exist.\",\n\"errorCode\": \"SORT_UNKNOWN_FIELD\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending, as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter, the same field with opposite sorting criterias."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some sort fields have duplicated fields.\",\n\"status\": 400,\n\"detail\": \"Conflicting sort parameters: duplicate fields with opposite directions.\",\n\"errorCode\": \"SORT_HAS_OPPOSITE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Sort parameter error length.\",\n\"status\": 400,\n\"detail\": \"Sort parameter should not be empty.\",\n\"errorCode\": \"SORT_IS_EMPTY\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Referencing a non-existing Knowledge Model."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Knowledge Model not found.\",\n\"status\": 404,\n\"detail\": \"Knowledge Model with id 'XXXX' was not found.\",\n\"errorCode\": \"KM_MODEL_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Referencing a non-existing record."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Records not found.\",\n\"status\": 404,\n\"detail\": \"Record Id(s) does not exist in Knowledge Model.\",\n\"errorCode\": \"KM_RECORD_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"data-endpoint-errors","__idx":2},"children":["Data Endpoint Errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"40%","rowSpan":2,"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returned when"]}," "," "]},{"$$mdtype":"Tag","name":"th","attributes":{"colSpan":2,"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}," "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not sending the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kpis"]}," parameters."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Missing parameters.\",\n\"status\": 400,\n\"detail\": \"Required request parameter 'fields' for method parameter type List is not present\",\n\"errorCode\": \"GENERAL_PARAMETER_MISSING\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Passing an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some params have constraint violations.\",\n\"status\": 400,\n\"detail\": \"[fields: size must be between 1 and 200]\",\n\"errorCode\": \"GENERAL_CONSTRAINT_VIOLATION\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requesting a non-existing field as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Field not found.\",\n\"status\": 400,\n\"detail\": \"Fields not found: test. Note: Fields are case sensitive.\",\n\"errorCode\": \"KM_FIELD_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requesting a non-existing field in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Unknown sorting fields\",\n\"status\": 400,\n\"detail\": \"These fields don't exist at the given record [test].\",\n\"errorCode\": \"SORT_UNKNOWN_FIELD\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Referencing a non-existing filter as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Filter not found.\",\n\"status\": 404,\n\"detail\": \"Filter not Found: name.\",\n\"errorCode\": \"FILTERS_FILTER_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using a non-filterable field in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Field not filterable.\",\n\"status\": 400,\n\"detail\": \"Field not filterable: mykpi\",\n\"errorCode\": \"FILTERS_FIELD_UNFILTERABLE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid expression as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Invalid expression structure.\",\n\"status\": 400,\n\"detail\": \"Invalid expression structure: mykpi eq\",\n\"errorCode\": \"FILTERS_EXPRESSION_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid operator for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Invalid expression Operator.\",\n\"status\": 400,\n\"detail\": \"Invalid expression Operator: sq\",\n\"errorCode\": \"FILTERS_OPERATOR_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid syntax for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": Failure getting results.\",\n\"status\": 400,\n\"detail\": \"Syntax error found in filterExpr. Please refer to the API documentation.\",\n\"errorCode\": \"GENERAL_RESULTS_FAILURE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," bigger than 19.(When using pageSize = 50)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some params have constraint violations.\",\n\"status\": 400,\n\"detail\": \"[page: value must be between 0 and 19]\",\n\"errorCode\": \"PAGE_VALUE_ILLEGAL\"\n}  \n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," bigger than 50."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some params have constraint violations.\",\n\"status\": 400,\n\"detail\": \"[pageSize: size must be between 1 and 50]\",\n\"errorCode\": \"PAGE_SIZE_ILLEGAL\"\n}   \n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending special characters in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter.\t400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Special characters are not allowed.\",\n\"status\": 400,\n\"detail\": \"Some special characters were found and they are not allowed for querying.\",\n\"errorCode\": \"GENERAL_CHARS_NOTALLOWED\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifying a date in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," in the wrong format."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Invalid Value format.\",\n\"status\": 400,\n\"detail\": \"Invalid Value format: \",\n\"errorCode\": \"GENERAL_WRONG_VALUE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid option in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Query option not supported.\",\n\"status\": 400,\n\"detail\": \"[options: illegal option 'invalid']\",\n\"errorCode\": \"OPTION_ILLEGAL\",\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["There is an unexpected error as part of this request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": No data found.\",\n\"status\": 400,\n\"detail\": \"Error details\",\n\"errorCode\": \"GENERAL_EMPTY_DATA\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["There is an unexpected error as part of this request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Knowledge Model Field Id repeated.\",\n\"status\": 400,\n\"detail\": \"Knowledge Model with repeated Field Ids: [FIELD_ID]. Please fix the Knowledge Model configuration.\",\n\"errorCode\": \"KM_FIELD_ID_DUPLICATED\"\n\"type\": \"https://developer.celonis.com/knowledge-model-api/error-catalog/\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using malformed error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchField"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchTerm"]}," are empty."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Malformed expression\",\n\"status\": 400,\n\"detail\": \"Term and field search parameters should be filled\",\n\"errorCode\": \"SEARCH_MATCH_EXPRESSION\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchField"]}," value is not exist."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Search match field not found\",\n\"status\": 400,\n\"detail\": \"Field not found: XXX\",\n\"errorCode\": \"SEARCH_FIELD_NOT_FOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kpis"]}," value is not exist."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"KPI not found.\",\n\"status\": 400,\n\"detail\": \"KPI not found: kpiId. Note: KPI are case sensitive.\",\n\"errorCode\": \"KM_KPI_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kpis"]}," value contains special characters."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"KPI not allowed.\",\n\"status\": 400,\n\"detail\": \"KPI contains not allowed special chars\",\n\"errorCode\": \"KM_KPI_ILLEGALCHARS\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," value does not contain recordId."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Field with wrong format.\",\n\"status\": 400,\n\"detail\": \"Field with wrong format, it should contain recordId.fieldId: fieldId\",\n\"errorCode\": \"GENERAL_PARAMETER_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-endpoints-errors","__idx":3},"children":["Query Endpoints Errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"40%","rowSpan":2,"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returned when"]}," "," "]},{"$$mdtype":"Tag","name":"th","attributes":{"colSpan":2,"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}," "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not sending the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Missing parameters.\",\n\"status\": 400,\n\"detail\": \"Required request parameter 'fields' for method parameter type List is not present\",\n\"errorCode\": \"GENERAL_PARAMETER_MISSING\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Passing an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some params have constraint violations.\",\n\"status\": 400,\n\"detail\": \"[fields: size must be between 1 and 200]\",\n\"errorCode\": \"GENERAL_CONSTRAINT_VIOLATION\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requesting a non-existing field as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Field not found.\",\n\"status\": 400,\n\"detail\": \"Fields not found: test. Note: Fields are case sensitive.\",\n\"errorCode\": \"KM_FIELD_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requesting a non-existing field in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Unknown sorting fields\",\n\"status\": 400,\n\"detail\": \"These fields don't exist at the given record [test].\",\n\"errorCode\": \"SORT_UNKNOWN_FIELD\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Referencing a non-existing filter as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Filter not found.\",\n\"status\": 404,\n\"detail\": \"Filter not Found: name.\",\n\"errorCode\": \"FILTERS_FILTER_NOTFOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using a non-filterable field in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Field not filterable.\",\n\"status\": 400,\n\"detail\": \"Field not filterable: mykpi\",\n\"errorCode\": \"FILTERS_FIELD_UNFILTERABLE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid expression as part of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Invalid expression structure.\",\n\"status\": 400,\n\"detail\": \"Invalid expression structure: mykpi eq\",\n\"errorCode\": \"FILTERS_EXPRESSION_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid operator for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Invalid expression Operator.\",\n\"status\": 400,\n\"detail\": \"Invalid expression Operator: sq\",\n\"errorCode\": \"FILTERS_OPERATOR_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid syntax for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": Failure getting results.\",\n\"status\": 400,\n\"detail\": \"Syntax error found in filterExpr. Please refer to the API documentation.\",\n\"errorCode\": \"GENERAL_RESULTS_FAILURE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," bigger than 19. (When using pageSize = 50)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some params have constraint violations.\",\n\"status\": 400,\n\"detail\": \"[page: value must be between 0 and 19]\",\n\"errorCode\": \"PAGE_VALUE_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," bigger than 50."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Some params have constraint violations.\",\n\"status\": 400,\n\"detail\": \"[pageSize: size must be between 1 and 50]\",\n\"errorCode\": \"PAGE_SIZE_ILLEGAL\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending special characters in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Special characters are not allowed.\",\n\"status\": 400,\n\"detail\": \"Some special characters were found and they are not allowed for querying.\",\n\"errorCode\": \"GENERAL_CHARS_NOTALLOWED\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifying a date in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]}," in the wrong format."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Invalid Value format.\",\n\"status\": 400,\n\"detail\": \"Invalid Value format: \",\n\"errorCode\": \"GENERAL_WRONG_VALUE\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using an invalid option in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Query option not supported.\",\n\"status\": 400,\n\"detail\": \"[options: illegal option 'invalid']\",\n\"errorCode\": \"OPTION_ILLEGAL\",\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["There is an unexpected error as part of this request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": No data found.\",\n\"status\": 400,\n\"detail\": \"Error details\",\n\"errorCode\": \"GENERAL_EMPTY_DATA\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using malformed error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchField"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchTerm"]}," are empty."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Malformed expression\",\n\"status\": 400,\n\"detail\": \"Term and field search parameters should be filled\",\n\"errorCode\": \"SEARCH_MATCH_EXPRESSION\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using error when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchField"]}," value is not exist."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Search match field not found\",\n\"status\": 400,\n\"detail\": \"Field not found: XXX\",\n\"errorCode\": \"SEARCH_FIELD_NOT_FOUND\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending special characters in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchField"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Search match fields not allowed.\",\n\"status\": 400,\n\"detail\": \"Search match fields contain prohibited special characters.\",\n\"errorCode\": \"SEARCH_FIELDS_ILLEGALCHARS\"\n}\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending special characters in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchTerm"]}," parameter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n\"title\": \"Search match terms not allowed.\",\n\"status\": 400,\n\"detail\": \"Search match terms contain prohibited special characters.\",\n\"errorCode\": \"SEARCH_TERMS_ILLEGALCHARS\"\n}\n","lang":"javascript"},"children":[]}]}]}]}]}]}]},"headings":[{"value":"Knowledge Model API Error Catalog","id":"knowledge-model-api-error-catalog","depth":1},{"value":"Schema Endpoints Errors","id":"schema-endpoints-errors","depth":2},{"value":"Data Endpoint Errors","id":"data-endpoint-errors","depth":2},{"value":"Query Endpoints Errors","id":"query-endpoints-errors","depth":2}],"frontmatter":{"seo":{"title":"Knowledge Model API Error Catalog"}},"lastModified":"2026-03-06T18:08:39.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/knowledge-model-api/api-reference/error-catalog","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}