a!integrationError() Function

System Functions

This function cannot be used with Custom Record Field Expressions. It can only be used with Offline Mobile if it is loaded at the top of the form.
For a full list of functions and their feature compatibility, explore the Appian Functions table.

Function

a!integrationError( title, message, detail )

Creates an integration error value. Use when configuring custom error handling for integration objects.

Parameters

Keyword	Type	Description
`title`	Text	A short summary of the error or the error type.
`message`	Text	A description of the error.
`detail`	Text	Technical details about the error, including error codes or underlying error messages.

Returns

Integration error value

Usage considerations

Get error values

fv!success, fv!error, and fv!result can be used to get response values from any errors.

Example

In a call to another system that does not support PUT, the following error message:

=a!integrationError(
  title: fv!error.title,
  message: fv!result.statusCode & "- " & fv!error.message,
  detail: fv!error.detail
)

Results in:

IntegrationError
    title: "The external system cannot support the request"
    message: "405 - The requested URL does not support the PUT method"
    detail: "HTTP/1.1 405 Method not allowed"

Open in Github Built: Tue, Oct 03, 2023 (08:54:41 PM)

a!integrationError() Function