append() Function

Function

Copy link to clipboard

append( array, value )

Appends a value or values to the given array, and returns the resulting array.

See also:

• insert(): Use this function to add items to the beginning or middle of an array.
• joinarray(): Use this function to insert a string element between each item in the resulting array.

Parameters

Copy link to clipboard

Returns

Copy link to clipboard

Any Type Array

Usage considerations

Copy link to clipboard

Data types of array items

Copy link to clipboard

The array to be modified can contain items of one or more types. When all array items are a single type, the value must be the same type as the current items in the array. The updated array will be a List of that type. For example, append({10, 20}, 30) returns 10, 20, 30, a List of Number (Integer).

Any values that are not the same type will not be added. For example, append({10, 20, 30, 40}, "fifty") returns 10, 20, 30, 40, null because the text value ("fifty") cannot be added to an array of numbers.

An array with values of more than one type returns a List of Variant. For example, append({10, "twenty"}, 30) returns 10, "twenty", 30.

You can append values of any type to these mixed-type arrays. For example, append({10, "twenty"}, 30.15) returns 10, "twenty", 30.15, a list of variant types with an integer, text string, and decimal.

Examples

Copy link to clipboard

Append one item to an array of one type

Copy link to clipboard

1
2
3
4
append(
  {10, 20, 30, 40},
  50
)
Copy

Returns {10, 20, 30, 40, 50}. When the array contains items of one type, the value must be the same type.

If value is not the same type, a null is appended. For example:

1
2
3
4
append(
  {10, 20, 30, 40},
  "fifty"
)
Copy

Returns {10, 20, 30, 40, null} because the text value cannot be added to an array of numbers.

Append an array to an empty array

Copy link to clipboard

1
2
3
4
append(
  {},
  {60, 70}
)
Copy

Returns {60, 70}.

Append one array to another

Copy link to clipboard

1
2
3
4
append(
  {10, 20, 30, 40},
  {50, 60, 70}
)
Copy

Returns {10, 20, 30, 40, 50, 60, 70}.

Append multiple arrays

Copy link to clipboard

1
2
3
4
5
append(
  {"Red", "Green"},
  {"Blue", "Yellow"},
  {"Brown", "White"}
)
Copy

Returns {"Red", "Green", "Blue", "Yellow", "Brown", "White"}.

Append decimal numbers to an integer array

Copy link to clipboard

When appending a Number (Decimal) value to an array of Number (Integer), Appian will round the decimal value to the nearest integer.

1
2
3
4
append(
  {10, 20},
  30.49
)
Copy

Returns {10, 20, 30}.

1
2
3
4
append(
  {10, 20},
  30.5
)
Copy

Returns {10, 20, 31}.

Feature compatibility

Copy link to clipboard

Feedback

Copy link to clipboard