REST API Error Codes Overview
Authors:
Holger Lierse, Kirill Gaiduk
Changed on:
26 May 2025
Overview
Fluent REST API returns specific HTTP Error Codes which may vary depending on the API endpoint and are explained in this document.
Key points
- Categorization by HTTP Status Code: The errors are organized by standard HTTP status codes (e.g., 400, 401, 403, etc.), which helps developers quickly understand the type of issue
- Coverage of Common Scenarios: The examples span a range of typical failure conditions, from authentication issues to plugin errors and timeouts, offering a practical reference for API consumers
REST API Error Codes Examples
The Error Code examples returned by the Fluent REST API are provided below.
Error Code: 400 Examples
Invalid Credentials
1{
2 "error": "invalid_grant",
3 "error_description": "Bad credentials"
4}Language: json
Name: 400 - Bad credentials
Description:
Bad credentials
Endpoint: POST /oauth/token
Missing Name
1{
2 "errors": [
3 {
4 "code": "400",
5 "message": "'name' is required"
6 }
7 ]
8}Language: json
Name: 400 - 'name' is required
Description:
Bad Request
Endpoint: POST /api/v4.1/job **
Invalid JAR file
1{
2 "message": "\"tmpfile\" is not a valid JAR file",
3 "status": 400
4}Language: json
Name: 400 - \"tmpfile\" is not a valid JAR file
Description:
Bad Request
Endpoint: POST /orchestration/rest/v1/plugin/upload
FAILED Event
1{
2 "eventId": "74d61610-1f0f-11eb-9c14-f349e6caa9d2",
3 "entityId": "107",
4 "eventStatus": "FAILED",
5 "errorMessage": "Event has Failed"
6}Language: json
Name: 400 - Event has Failed
Description:
Event failure
Endpoint: POST /api/v4.1/event/sync
NO_MATCH Event
1{
2 "eventId": "a0a63630-1f0f-11eb-84d4-45738fb94811",
3 "entityId": "214",
4 "eventStatus": "NO_MATCH"
5}Language: json
Name: 400 - Event no match
Description:
Event no match (no matching Ruleset / Entity could be found)
Endpoint: POST /api/v4.1/event/sync
Missing Retailer
1{
2 "errors": [
3 {
4 "code": "NotNull",
5 "message": "'retailerId' is required"
6 }
7 ]
8}Language: json
Name: 400 - 'retailerId' is required
Description:
Bad Request
Endpoint: PUT /api/v4.1/workflow
Error Code: 401 Examples
Missing Retailer
1{
2 "errors": [
3 {
4 "code": "InvalidInput",
5 "message": "Logged in user has no retailer"
6 }
7 ]
8}Language: json
Name: 401 - Logged in user has no retailer
Description:
Invalid Bearer Token
Endpoints:
- POST /api/v4.1/event/async
- POST /api/v4.1/event/sync
- POST /orchestration/rest/v1/plugin/ **
- GET/POST /api/v4.1/job **
- GET /api/v4.1/workflow **
Invalid User
1{
2 "errors": [
3 {
4 "code": "401",
5 "message": "Invalid user, Authorization header value does not belong to a valid user"
6 }
7 ]
8}Language: json
Name: 401 - Invalid user, Authorization header value does not belong to a valid user
Description:
Invalid Bearer Token
Endpoint: GET /api/v4.1/event
Invalid Authentication Object
1{
2 "error": "unauthorized",
3 "error_description": "An Authentication object was not found in the SecurityContext"
4}Language: json
Name: 401 - An Authentication object was not found in the SecurityContext
Description:
Invalid Bearer Token
Endpoint: PUT /api/v4.1/workflow
Error Code: 403 Examples
Missing Permissions
1{
2 "errors": [
3 {
4 "code": "403",
5 "message": "User null does not have permission WORKFLOW_VIEW in context PermissionContext(type=RETAILER, id=1)"
6 }
7 ]
8}Language: json
Name: 403 - User null does not have permission WORKFLOW_VIEW in context PermissionContext(type=RETAILER, id=1)
Description:
Forbidden
Endpoint: GET /api/v4.1/workflow
Error Code: 406 Examples
Invalid Plugin
1Only Verified Bundles Can be InstalledLanguage: json
Name: 406 - Only Verified Bundles Can be Installed
Description:
Not Acceptable
Endpoint: POST orchestration/rest/v1/plugin/install
Error Code: 500 Examples
Unsupported Operation
1{
2 "errors": [
3 {
4 "code": "500",
5 "message": "Request method 'GET' not supported"
6 }
7 ]
8}Language: json
Name: 500 - Request method 'GET' not supported
Description:
Unsupported HTTP operation
Endpoint: n/a
Internal Server Error
1{
2 "errors": [
3 {
4 "code": "500",
5 "message": "An unknown error occurred"
6 }
7 ]
8}Language: json
Name: 500 - An unknown error occurred
Description:
Internal Server Error
Endpoint: GET /api/v4.1/workflow/ **
Failed Request
1<html>
2
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5 <title>Error 500 Request failed.</title>
6</head>
7
8<body>
9 <h2>HTTP ERROR 500</h2>
10 <p>Problem accessing /rest/v1/plugin/bundleStatus. Reason:
11 <pre> Request failed.</pre>
12 </p>
13 <hr><i><small>Powered by Jetty://</small></i>
14 <hr />
15
16</body>
17
18</html>Language: json
Name: 500 - Request failed
Description:
Request Failed
Endpoint: POST /orchestration/rest/v1/plugin/bundleStatus
Error Code: 504 Examples
Gateway Timeout
1<html>
2
3<head>
4 <title>504 Gateway Time-out</title>
5</head>
6
7<body>
8 <center>
9 <h1>504 Gateway Time-out</h1>
10 </center>
11</body>
12
13</html>Language: json
Name: 504 - Gateway Time-out
Description:
Gateway timeout
Endpoint: GET /api/v4.1/event
