a!httpFormPart() Function

Function

a!httpFormPart( name, contentType, value )

Creates an HTTP form part which can be passed in an integration’s multipart request body.

Parameters

Usage considerations

For integrations that have a request body, you can send multiple types of data in a single request by choosing Multipart Form Data (multipart/form-data) for the Content Type.

Using the form to define the multipart request

If you have a static number of form parts that don't require additional logic, you can specify values for each part using the form.

Using an expression to define the a multipart request

If you want to use conditional logic or send a dynamic number of form parts, you can select Define all parts with a single expression, and define the form parts using an array of a!httpFormPart() functions. This can be helpful if you have multiple form parts that can be sent as a part of the integration, but some of them are optional.

Example

Using conditional logic for a multipart request

The following interface is from an automated application deployment app. When users fill out a request to deploy an application, they can upload up to three different files. However, depending on their needs, they may only need to upload one or two files.

The information from the form is passed into an integration that sends the file and text data as multipart form data.

To configure the integration object for this app, after filling out the Connection information, choose Multipart Form Data (multipart/form-data) in the Request Body section.

Since you need to use conditional logic to determine which files to send with the request, choose Define all parts with a single expression and enter the following expression.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*The application UUID is always sent with the request*/
{
  a!httpFormPart(
    name: "applicationUUID",
    contentType: "text/plain",
    value: ri!applicationUUID
  ),

  /*ri!applicationFile, ri!propertiesFile, and ri!sqlFile rule inputs are Document data types*/
  if
  (
    isnull(ri!applicationFile),
    {},
    a!httpFormPart(
      name: "applicationFile",
      /*Because this is a document, we set the value to "auto-detect"*/
      contentType: "auto-detect",
      value: ri!applicationFile
    )
  ),

  if
  (
    isnull(ri!propertiesFile),
    {},
    a!httpFormPart(
      name: "propertiesFile",
      contentType: "auto-detect",
      value: ri!propertiesFile
    )
  ),

  if
  (
    isnull(ri!sqlFile),
    {},
    {
      a!httpFormPart(
        name: "sqlFile",
        contentType: "auto-detect",
        value: ri!sqlFile
      ),
      /*ri!sqlDataSource rule input is a Text data type*/
      a!httpFormPart(
        name: "sqlDataSourceName",
        contentType: "text/plain",
        value: ri!sqlDataSource
      )
    }
  )
}

Feature compatibility

Feedback