Response
Create Error Message
Creates a custom error message and returns it in a list (array). It runs when all the input link points are active.
| Multi input | ✔️ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| trigger | trigger | Trigger of the node, mainly used to initiate execution of the node. |
Output link points
| Name | Type | Description |
|---|---|---|
| errorMessage | list | Newly created error message returned in a list (array) |
| errors | list | Errors occurred during node execution |
Parameters
| Name | Type | Description |
|---|---|---|
| Error code | required | The short textual code of the error. |
| Error message | required | Description of the error |
| Error management | required | Error handler type of processing errors raised by this node, either automatically or manually. |
Finish with Errors
info
Return with Errors node can only be used in the task or messaging services. This node is not available for endpoint services.
Terminates execution of the service and logs the provided error message(s). It runs when the error input link points is active.
| Multi input | ❌ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| error | value | Triggers the execution of the node, provides either a single or a list of error messages that will be logged. |
Output link points
No output link points available for this node.
Parameters
No parameters are available for this node.
Finish Successfully
info
Return Successfully node can only be used in the task or messaging services. This node is not available for endpoint services.
Terminates execution of the service successfully. It runs when all the trigger input link points is active.
| Multi input | ❌ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| trigger | trigger | Triggers the execution of the node. |
Output link points
No output link points available for this node.
Parameters
No parameters are available for this node.
Return Error Response
info
Return Error Response node can only be used in endpoint services. This node is not available for the task or messaging services.
Terminates execution of the service and returns the provided (if any) input objects and object lists in the response body with an HTTP error response code. It runs when all the input link points are active.
| Multi input | ✔️ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| trigger | trigger | Triggers the execution of the node |
Output link points
No output link points available for this node.
Parameters
| Name | Type | Description |
|---|---|---|
| Return preference | required | Return object with using its input link point name as the key or not. If there is only one object connected to this node then return its values as it is without using its name as the key |
| HTTP error code | required | The 4xx class of HTTP status code that will be returned as the response |
| Omitted fields | optional | List of excluded fields in response |
Return File Response
info
Return File Response node can only be used in endpoint services. This node is not available for the task or messaging services.
Terminates execution of the service and returns the provided file either inline or as an attachment of the response body with a response code of 200 (OK). It runs when the input file is active.
| Multi input | ❌ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| file | object | The file object that will be returned |
Output link points
No output link points available for this node.
Parameters
| Name | Type | Description |
|---|---|---|
| File disposition type | required | Either inline or attachment. Inline indicates that the entity should be immediately displayed to the user, whereas attachment means that the user should take additional action to view the entity. |
Return HTML Response
info
Return HTML Response node can only be used in endpoint services. This node is not available for the task or messaging services.
Terminates execution of the service and returns the specified HTML to the calling party with an HTTP success response code of 200 (OK). It runs when all the input link points are active.
| Multi input | ✔️ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| object | object | Input object of the node |
Output link points
No output link points are available for this node.
Parameters
| Name | Type | Description |
|---|---|---|
| HTTP response code | required | The class of HTTP status code that will be returned as the response |
| HTML response | optional | The HTML document that will be returned to the calling party |
Return Response
info
Return Response node can only be used in endpoint services. This node is not available for the task or messaging services.
Terminates execution of the service and returns the provided input object and object lists in the response body with the specified HTTP response code. It runs when the response link point is active.
| Title | Title |
|---|---|
| Multi input | ❌ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| response | value | Object or object list that will be returned in response body |
Output link points
No output link points available for this node.
Parameters
| Name | Type | Description |
|---|---|---|
| HTTP response code | required | The class of HTTP status code that will be returned as the response |
Return Success Response
info
Return Success Response node can only be used in endpoint services. This node is not available for the task or messaging services.
Terminates execution of the service and returns the provided (if any) input objects and object lists in the **** response body with an HTTP success response code of 200 (OK). It runs when all the input link points are active.
| Title | Title |
|---|---|
| Multi input | ✔️ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| trigger | trigger | Triggers the execution of the node |
Output link points
No output link points available for this node.
Parameters
| Name | Type | Description |
|---|---|---|
| Return preference | required | Return object with using its input link point name as the key or not. If there is only one object connected to this node then return its values as it is without using its name as the key |
| Omitted fields | optional | List of excluded fields in response |
Redirect to URL
info
Redirect To URL node can only be used in endpoint services. This node is not available for the task or messaging services.
Terminates execution of the service and sends a special redirect response to a request with a specific URL to redirect to with HTTP response code of 302. It runs when all the input link points are active.
| Multi input | ✔️ |
| Multi output | ❌ |
Input link points
| Name | Type | Description |
|---|---|---|
| object | object | Input object of the node |
Output link points
No output link points are available for this node.
Parameters
| Name | Type | Description |
|---|---|---|
| Redirect URL | required | The URL to redirect to. |
| Query string parameters | optional | Name-value pairs that will be set as the query string parameters of the redirect URL. |