| Excerpt |
|---|
Low code interface for requesting data from RESTful APIs external to the capture process. Use this node when no vendor specific integration (Netsuite, Dynamics 365, Quickbooks Online) exists. |
| Note |
|---|
Universal iPaaS is a licensed feature. Demo licenses can consume the feature, but fully licensed environments require the feature be available. Workflows using the node without a license will error. |
All Square 9 iPaaS nodes provide the same level of functionality. In some cases, a vendor specific integration may exist. Generally this is to handle specific requirements of the host API as it relates to authentication. For most scenarios, the universal iPaaS node is appropriate.
...
| 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. Specific reformatting examples may be found here.
Header / Summary Data
Header responses are slightly different. For GET requests, the response is inspected for a value array. If found, key mapping is performed from element 0 of that array. In the table example above, only the first vendor would map to the header fields if they were present. In other words, if your workflow had process fields for vendorName and vendorId respectively, given the response, those fields would be assigned the values “Square 9 Softworks” and “77364”.
For POST and PATCH requests, the top level response to mapped. For example:
| Code Block |
|---|
{
"count":25
} |