Structure and identification codes of errors that can be thrown during different validation processes.

Introduction

Errors may occur in many different situations during the data processing. yuuvis® Momentum core offers in addition to the HTTP status code a well-defined structure and labeling of any thrown error. It is thus possible to easily localize the origin of the problem. At the same time, automated catching and analyzing of errors can be implemented based on the fixed error structure and error codes.

Error Structures

Single Errors

The errors are JSON structures with the following parameters:

{
    "httpStatusCode" : 409,
    "serviceErrorCode" : 2800,
    "time" : "2021-04-21T04:36:30.813",
    "message" : "A non-empty folder cannot be deleted.",
    "stackTrace" : [ "com.os.enaio.cloud.gateway.resource.api.DmsController.deleteDmsObject(DmsController.java:719)" ],
    "service" : "api",
    "tenant" : "default"
}

Error Lists during Validation Processes

If errors occur during one of the following validation process, they are collected and returned in a list validationErrors in JSON format.

• schema validation
• role set validation
• app set validation

Other validation processes return only single errors in the structure described above.

Within the JSON list validationErrors, the following parameters are provided for each error in the list:

Together with each non-empty validation errors list, the HTTP status code 422 is always returned, but not extra included into the individual entries.

The following code block shows an example error structure that can occur during a schema validation:

{
	"validationErrors": [
		{
			"message": "Ambiguous ids. There are 2 property type definitions with the id 'from'.",
			"serviceErrorCode": 2110
		},
		{
			"message": "Wrong base id. The base id of the system:document type definition 'email' must be 'system:document', but it is 'system:folder'.",
			"serviceErrorCode": 2131
		},
		{
			"message": "Invalid property reference 'fromm' in type definition 'email'.",
			"serviceErrorCode": 2132
		},
		{
			"message": "Invalid secondary object type reference 'appAcl:aclowner' in type definition 'email'.",
			"serviceErrorCode": 2135
		}
	]
}

Error Codes and Messages

The table provides an overview of errors that might occur during operation of yuuvis® Momentum core.

Note: In case you want to catch errors and analyse their content, please use the serviceErrorCode as unique identification of the error type. Please do NOT use the message since we reserve to modify it in future.