Errors

caution

Can only be used in Entities pipelines (see Entities).

Description

The Error pipe interrupts the execution of an event in the pipeline with an error. Allows you to set the error code and text.

Peculiarities:

• Has no exits;
• params.message must be a text.

Structure

|Field|Value|Type|Example|Required|Description| |id|number|10|yes|Pipe's ID| |type|string|"error"|yes|Pipe's type| |params|ErrorParamsObject|no|Type-specific's parameters| |outsOutsObject|no|Pipe's outputs|

ErrorParamsObject
Fi	Type	Example	Reqiered	Description
code	number	400	no	Error code
message	srtring	"$in.data.response.error_message"	no	Text of an error. Can not be empty if it was specified

Errors

Error processing params.message is your template is incorrect or the field was not found.

Examples

Example 1:

{
  "id": 10,
  "type": "error",
  "params": {
    "code": 500
  }
}

Example 2:

{
  "id": 10,
  "type": "error",
  "params": {
    "code": 500,
    "message": "$in.data.error"
  }
}