RestApi

The RestApi plugin lets you reference an Api and return a string or JSON response.  

Parameters are as follows, examples are shown in bold: 

source  The url up to but not including the resource
https://mydomin.com/api 
api  The api resource required
orders/1023 
queryString  Optional querystring parameters
option=6&type=small 
headers  Optional JSON dictionary of header values
{Authorization:”{=Join(Bearer ,=RawValue(Response,Token))}”} 
form  For post method, a JSON dictionary of form values
{“UserId”:”abc123″,”Password”:”je83d!m“} 
method  get (default) or post 
root  Optional path to the root of the section required
orderLines[2].product 
asString  true if a string value is expected or required (saved as column “Response”) 

If the object returned (and optionally located using the root) is an array, each element represents a row in the resulting data group. 

If the data group is referenced as a base to any RestApiRelative data groups the full returned object (without filtering by root) is saved for use by the relatives. Note that only a top level (no parent) data group can be a relative base. # 

RestApiRelative 

This plugin lets you reference a RestApi data group and return data relative to it. 

Parameters are: 

base  The id of the RestApi data group containing the data from the API 
root  Path to the root of the section requried, such as orderLines[2].product 

If the object referenced is an array, each element represents a row in the resulting data group. 

image_pdfimage_print