The static default value of the hidden field. If an "Initial Value Query" is configured that returns a result, the default value is replaced by this result.

The property of the hidden field. This property will be sent to the server via REST as part of a JSON object. For example, if the property name is 'marketingCampaign' and the value is configured to 'socialPlatformX', the JSON sent to the server will be as follows: {"marketingCampaign": "socialPlatformX"}.

marketingCampaign

referredFrom

The ID of the element in the HTML. If no ID is set, the 'property' is used as the ID.

If enabled, this value is submitted to the server. Otherwise, it is only used locally (e.g. to confirm inputs of other fields).

true

JSONPath query to fetch the field value from the initial REST call response. Requires an initial REST call to be configured in this custom step UI. If the query yields multiple results, the first one is set as the initial value and all others are discarded.

See the JSONPath documentation for the full documentation: https://github.com/dchester/jsonpath

Examples:

Assume the initial REST call returns the following JSON response:

{
 "meta": {
   "type": "jsonapi.metadata.document",
   "timestamp": "2023-03-10T13:06:01.294+02:00"
 },
 "data": [
  {
    "type": "user",
    "id": "user1",
    "attributes": {
      "contextData": {
         "givenname": "User1",
         "surname": "FSMTest",
         "roles": "customerA"
      }
    }
  },
  {
    "type": "user",
    "id": "user2",
    "attributes": {
      "contextData": {
        "givenname": "User2",
        "surname": "FSMTest",
        "roles": "customerB"
      }
    }
  }
 ]
}

The following table shows the results of various JSONPath queries given the JSON above:

Description JSONPath Query Extracted Initial Value Static path from the root $.meta.type jsonapi.metadata.document The role of the user whose id equals "user1" $.data[?(@.id == 'user1')].attributes.contextData.roles customer The number of users $.data.length 2 All "givenname" attributes
Note:
This query yields multiple results.
The first one is set to the initial value, the rest is discarded. $..givenname User1

$.store.bicycle.color

$..phoneNumber

$..data[?(@.id == 'street')].attributes.currentValue