`getFormState`

This function loads data into the state via the specified URL. To do this, an GET message is sent. The data is not completely replaced, but rather merged.

Overview

action ("getFormState"): Action to be executed.
payload (GetFormStateActionPayload): Object containing the specified URL.

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.0.x/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

Open preview in a separate window

Keywords: