Handle Export Service API errors and exceptions
Error handling in Export Service API returns specific error codes and error messages for every response for failed HTTP request, or when you request all errors that occurred during the export of a specific data source.
Error code structure
Error codes returned from the Export Service API endpoint has the following structure, [Sources].[Error Types].[Operations].[Error numbers]. For example, JOB.01 is returned when an incorrect total items processed number.
Sources
The possible source codes for an error code are listed in the following table:
Source |
Description |
JOB |
Jobs |
CONF |
Configuration |
EXT |
External |
ITEM |
Item |
MES |
Message |
IO |
Input/Output |
Error Types
The possible error types for an error code are listed in the following table:
Type |
Description |
GET |
Receiving data |
CRE |
Creatiing |
IMG |
Image file |
PDF |
PDF file |
MSA |
MsAccess |
PRO |
Production |
LFL |
Main load file |
SCH |
Scheduling |
TS |
Transfer service |
OM |
Object manager |
SQL |
Structured Query Language |
FS |
Folder service |
DG |
Data grid |
DATA |
Corrupted data |
VLD |
Validation |
Operations
The possible operations for an error code are listed in the following table:
Operation |
Description |
GET |
Get |
COPY |
Copy |
SAVE |
Save |
DELETE |
Delete |
CHECK |
Check |
Error numbers
Error numbers have four digits. Digits on the first and on the second position have specific meanings.
The first digits meaning is the same for all error types.
Resource code |
Description |
0XXX |
General error |
1XXX |
Job related error |
2XXX |
Configuration related error |
3XXX |
Source related error |
4XXX |
ItemErrors related error |
The second digits meaning differs for each error type.
Error Type |
Resource code |
Description |
INT |
X[0-9]XX |
Service errors |
EXT |
X[0-9]XX |
Runtime errors |
VLD |
X0XX |
Invalid input data |
VLD |
X5XX |
System state does not allow to execute request |
VLD |
X6XX |
Data in the system does not exist |
VLD |
X7XX |
Data in the system is incorrect |
VLD |
X9XX |
Data in the system is corrupted |