POSTing Data Using the REST Client
Last updated
Last updated
© Copyright 2023, Astera Software
The Astera REST client component can be used to POST data to web servers. However, there are some inherent axioms when it comes to the way Astera maps hierarchical data that may present some challenges when trying to compose a JSON payload to the web server. This document will list the most common challenges and concepts and how to deal with them in Astera.
The issue of cardinality is probably the biggest issue facing an Astera developer when using the REST component. Depending on what the mapping into the data structure under the Input node looks like, you could end up with a completely different payload being sent to the web server. For example, take a look at the following screen capture:
This example shows an XML file with 3 SalesOrder nodes being mapped into the item collection under the Input node of the RestClient1 action. A preview of the Passthru showing just the orders is below:
And here is the preview of the union of all line items under all orders;
Notice that there are 3 orders and a total of 9 line items. Actually, there are 3 line items for every order. And in fact, we would like to make a grand total of 3 REST POSTs consisting of all line items for a particular order. However, the way we have the mapping set up, we end up with 9 separate REST requests to the web server.
Now watch what happens when we map something to the URL parameter. We now get 3 POSTs to the server. Each with a collection of line items instead of just one.
Why does this happen? This is because when mapping into a tree, the source tree will pass along the topmost node mapped as the “record”. When we were only mapping from line item collection, we had 9 records. When we included maps from the order, we suddenly had 3 records. So you should have a “parent” record for each REST request you wish to make.
So what if your source was a flat structure such as an Excel Workbook or Database Table? In that case, you will create a REST request for every row in the source grid. To get around this, you must make a tree to create desired JSON or XML data. A good way to do this would be to use the Tree Join transformation.
By default, Astera will treat XML and JSON identically. This is because they are very similar and we use the same writer technology to form JSON or XML. However, some differences arise which highlight some XML rules that limit the kind of JSON that can created for a REST request.
The most obvious of these rules is the one that, for XML, states that you can only have a single root object in XML. This is not the case for JSON. For example, look at the following JSON:
Notice that this is a javascript array with no root. This is legal JSON, but notice the resultant tree structure that is created. It has a phantom “root” object in the tree. This will produce JSON that will look slightly different from the sample JSON used the build the layout. To generate the rootless JSON array desired here, you must check the Omit Root If JSON. Note that this will not alter the tree at all. This option will only surface when the REST payload is being created.
