Request mapping

To send CyberApp form model data to the ISV service, we specify which model properties to send, and map these model properties to the callback request payload.
This is called request mapping.

With request mapping, the form model is on the left side, and the callback request payload is on the right side.
../../../_images/ss-uibuilder-requestmapping.png

To define request mapping

  1. Click Add mapping.

  2. Select a form model element from the left-side mapping dropdown list, and the callback request payload data item you want to map it to from the right-side mapping dropdown list.

  3. Repeat for all the model properties you have to send in the payload.

Note

If you make a mistake, you can change the selected items or click the delete button to delete the mapping.

Example 1

../../../_images/ss-uibuilder-requestmapping1.png

In this example, a button element has been defined to trigger the createuser callback when clicked. The createuser callback has a request payload:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "login": {
      "type": "string"
    }
  }
}

A request mapping is therefore expected to map three string elements from the model form to the createuser callback request payload schema.

Example 2

../../../_images/ss-uibuilder-requestmapping2.png

In this example, a table has an action button defined to trigger the resetpassword callback when clicked. The resetpassword callback has a request payload:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

A request mapping is therefore expected to map one of the table elements from the model form to the resetpassword callback request payload schema.