Common Process Error Codes

Content

• Overview
• Validation fieldErrors
• OperationError
• Revision History

Overview

This topic describes some of the common error codes that can occur when you invoke a Process.

Validation fieldErrors

This is generated during a JSR303 validation. Output includes fieldName, code, and message. It's mapped to the HTTP 400 status code.

{
    "processId": "640b4b3a-dbaf-4b73-abfb-979475aee0bb"
    "stepName": "UsernameInputStepName",
    "fieldErrors": [{
        "field": "accept",
        "code": "NotNull",
        "message": "May not be null",
    }],
    "lastFailedStepAction": {
      "displayMessage": "Please provide a username parameter",
      "parameters": {
        "parameter1": "value1",
        "parameter2": "value2"
      },
      "processId": "640b4b3a-dbaf-4b73-abfb-979475aee0bb",
      "stepName": "UsernameInputStepName"
    },
}

Status for Validation Error 400

ULM Business Error Code	Payload Model	Description
unexpected-field-error	StepActionResultWithErrorDto	The user entered unexpected input.

OperationError

This error is generated from a variety of error conditions that come from business code.

ULM Business Error Code	Error	Payload Model	Description
process-terminated-with-too-many-retries	400	StepActionResultWithErrorDto	Too many input attempts.
service-process-step-general-failure	Any	StepActionResultWithErrorDto	Generic error code.

Sample - StepActionResultWithErrorDto

{
  "lastFailedStepAction": {
    "displayMessage": "Please provide a username parameter",
    "parameters": {
      "parameter1": "value1",
      "parameter2": "value2"
    },
    "processId": "640b4b3a-dbaf-4b73-abfb-979475aee0bb",
    "stepName": "UsernameInputStepName"
  },
  "operationError": [
    {
      "code": "service-process-step-general-failure",
      "message": "Failed to perform something"
    }
  ],
  "fieldErrors": [
    {
      "code": "NotNull",
      "message": "Failed to perform something",
      "field": "userId"
    }
  ],
  "processId": "640b4b3a-dbaf-4b73-abfb-979475aee0bb",
  "stepName": "UsernameInputStepName"
}

Revision History

Version	Description
2020.09	Added this topic.