HTTP codes returned by WGS when processing calls:
HTTP codes | When return | What to do |
200,201,204 | Successful response | |
207 | Partially successful or several responses | Check the returned error object |
400 | Wrong parameters defined or internal operation call failed | Check returned error object |
401 | User is unauthorized | Access with authorized user for resource |
403 | Operation forbidden | Check the defined roles of user |
404 | Endpoint not found or object does not exist (PCF code 2085) | Check to ensure that the path is correct |
409 | Conflict passed parameter or missing authentication configuration | Check returned error object |
410 | Requested event(s) do not exist in database | Check returned error object |
500 | Cannot execute internal operation call, problem on WGS server | Check returned error object. Review WGS logs for additional diagnostics. |
504 | Operation call timeout | Check returned error object |
If an HTTP response returns an error object, the following fields may be included:
- type – error type:
- rest – if the problem is on the REST side
- pcf – if the problem is on an internal PCF command call
- java – if the problem is with server code execution
- messageId – WGS RestAPI error code.(See WGS REST API error codes by messageId below)
- message – error message
- explanation – explanation of error
- action – how the user can avoid the error
- code – PCF code, if it was returned on internal operation call. See the subCode bullet description below for details regarding PCF code 85001 (EXIA_SOLACE_EXCEPTION).
- codeStr – PCF code string, if it can be resolved by PCF code
- exception –Exception message related to internal operation failure. See the subCode bullet description below for details regarding PCF code 85001 (EXIA_SOLACE_EXCEPTION).
- attrExceptions – Exception related to one operation within an internal operation
- subCode – For Solace Exception errors with PCF code 85001 (EXIA_SOLACE_EXCEPTION), the "subCode" is the Solace error code for each condition. The "exception" field contains a description of the error, followed by the reason code and message in parentheses.
WGS REST API error codes by messageId
WGS code | HTTP code | Description |
WGS0001 | 403 | Cannot access resource |
WGS0002 | 401 | Unauthorized |
WGS0003 | 500 | Internal server error |
WGS0004 | 404 | Not found |
WGS0005 | 400 | Not defined object |
WGS0006 | 409 | Already exists |
WGS0007 | 400 | Object not created |
WGS0008 | 400 | Object not changed |
WGS0009 | 400 | Object not deleted |
WGS0010 | 409 | Node is managed |
WGS0011 | 400 | Rest parameter value not parsed |
WGS0012 | 400 | required value not set |
WGS0013 | 400 | object field not read |
WGS0014 | 400 | internal record field not read |
WGS0015 | 409 | OAuth not configured correctly |
WGS0016 | 403 | OAuth forbidden parameter |
WGS0017 | 401 | OAuth not authorized |
WGS0018 | 500 | Internal database exception |
WGS0019 | 409 | Some values have conflict |
WGS0020 | 400 | Attribute does not exist in object |
WGS0021 | 400 | Object attribute is duplicated |
WGS0022 | 400 | object method not read |
WGS0023 | 400 | object not read |
WGS0024 | 400 | Object not read |
WGS0025 | 410 | Object is gone |
WGS0026 | 400 | PCF attribute not read |
WGS0027 | 504 | PCF command timeout |
WGS0028 | 400 | Cannot parse object |
WGS0029 | 400 | Unsupported command |
WGS0030 | 409 | Basic Authentication not configured correctly |
WGS0031 | 404 | Active not found |
WGS0032 | 207 | Object partially created |
WGS0033 | 207 | Object partially changed |