Custom Request

Functions

Custom Request refers to customized configurations based on existing commercial interfaces, or encapsulating interfaces to flexibly meet business needs of the company, in order to achieve a series of operations such as interface fetching, data validation, data analysis, and trigger events.

Where to Set

In the design page of a form, go to Form Properties > Front-End Event > Settings：

Configurations of custom request are as follows:

Type of Custom Request

When the trigger field value changes, it will automatically trigger HTTP requests. Currently, there are two types of requests allowed:

?code=123

URL

URL is the server address you want to request. To use GET request, you need to put parameters to URL and insert fields into it to assign value to parameters.

Supported fields inserted and corresponding parse value formats are as follows:

Note: The length of URL depends on the configured server. Too long URL will be truncated, leading to transmission failure of some data parameters.

5. Header/Body

Methods of setting the two parameters are as follows:

Setting Header

You need to set Name and Value under Header on the Header/Body Settings page. You can insert fields into Value and supported fields are the same as those in the section "URL".

Up to 50 headers can be added to each custom request.

Setting Body

Based on different interfaces, you can select JSON or x-www-form-urlencoded under the parameter Body.

You need to set Name and Value under Body on the Header/Body Settings page. You can insert fields into Value and supported fields are the same as those in the section "URL".

Up to 50 bodies can be added to each custom request.

Response Format

There are two response formats: JSON and XML. The methods to parse them are as follows:

JSON Path

Take the following response as an example:

{
    "result": "content of result",
    "testResult": {
        "target": "content of target"
    },
    "data": [
        {
            "key": "iPad Air",
            "value": "2"
        },
        {
            "key": "iPad Pro",
            "value": "4"
        }
    ],
    "array": [
        "array1",
        "array2",
        "array3",
        "array4",
        "array5"
    ]
}

Corresponding responses entered by JSON Path are as follows:

XPath

Take the following response as an example:

<results>
   <result>content of result</result>
   <testResult>
       <target>content of target</target>
   </testResult>
   <data>
       <key>iPad Air</key>
       <value>2</value>
       <key>iPad Pro</key>
       <value>4</value>
   </data>
   <array>array1array2array3array4array5</array>
</results>

Corresponding responses entered by XPath are as follows:

Response Settings

You can assign data acquired from Front-End Event to fields of the form.

1. Click Click to Set under Response Settings:

2. Click Form field and its corresponding response and select fields for which you need to set responses from the drop-down list.

3. To configure assignment rules to response fields, you can assign value directly or by inserting fields of the form:

How to enter responses depends on the response format. If the response format is JSON, you need to enter responses by JSON Path. If the response format is XML, you need to enter responses by XPath.

4. Fields for which you can set responses and their corresponding parse values are as follows: