getFormState

This function loads data into the state via the specified url. For this purpose, a GET-Message The data is not completely replaced, but merged.

Overview

action ("getFormState")

Action to be executed.

payload (GetFormStateActionPayload)

Object containing the url to be specified.

GetFormStateActionPayload

url (string)

Url of the configuration to be loaded. If no url is specified, the stateUrl is used. If this is also not specified, the stateUrl is read from the Url Parameters, if available.

Example

getFormState.json
{
  "$schema": "https://forms.virtimo.net/5.1.0/schema.json",
  "metaData": {
    "id": 0,
    "version": 0
  },
  "configuration": {
  },
  "components": [
    {
      "type": "container",
      "components": [
        {
          "type": "button",
          "label": "getFormState",
          "onClick": {
            "action": "getFormState",
            "payload": {
              "url" : "https://files.virtimo.net/docs-dev/docs-develop/de/bpc-docs/5.1/forms/_attachments/getFormStateTarget.json"
            }
          }
        },
        {
          "type": "textfield",
          "value": "${/data/text}"
        }
      ]
    }
  ],
  "state": {
    "data": {
      "text": "Hallo"
    }
  }
}
Embedded preview

Keywords: