Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Use this feature when working with data fields that are concatenated, like vendor lists. It’s common for vendor lists to include vendor name and vendor id. The user needs to see a vendor name for indexing purposes, and the ERP needs the vendor id for creating transactions. It would be possible to make additional API requests to perform runtime data lookups, but it’s generally best practice to minimize requests where possible.

Format Expression

Note

NOTE: This is a RESPONSE formatter. It works against response data returned from an API.

The format expression is used to tune an API’s response to match an expected format by the iPaaS node. Each API can have it’s own response styling. Universal iPaaS attempts to automatically map header and table data from the response.

Info

A single request may map header fields, or table fields, but not both. While it would be uncommon, you could map data required for a header from a table response and set those values to a header field later in the workflow.

Tables

For table mapping, repeating results are expected to be returned in an array with a key of “value”. Acceptable table response would resemble:

Code Block
{
  "value":[
    {
      "vendorName":"Square 9 Softworks".
      "vendorId":"77364"
    },
    {
      "vendorName":"Microsoft",
      "vendorId":"77834"
    }
  ]
}

If would be impossible to document every variable response and how to reformat it. The comprehensive documentation on the formatting patterns may be found here.