Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
bordertrue


Column

Table of Contents

Table of Contents
exclude(Table of Contents|Read on|Schema - Defining Object Types|Apps|Tagging)


Introduction

Errors may occur in many different situations during the data processing. yuuvis® Momentum core offers a well-defined structure and labeling and 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 Structure

The errors are JSON structures with the following parameters:

ParameterDescription
httpStatusCodeThree-digit Integer specifying the type of errorHTTP status code as a class of the response in which the error is returned.
serviceErrorCodeFour-digit Integer specifying the concrete error type.
timeTimestamp of the error occurance in format "yyyy-MM-ddTHH:mm:ss.SSS".
messageString message describing the concrete error.
stackTraceOrigin of the error.
serviceThe name of the service that throwed the error.
tenantThe string tenant name where the error occured.

...

Code Block
languageyml
titleExample error structure.
{
    "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"
}

...

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.

...