CallRESTWebService component
This component allows you to call a REST web service from Linx. The following parameters are of particular importance when using this component:
| Name |
Type |
Description |
| URL |
String |
The base URL to use for the service request. This excludes any parameter-specific information that are send with the request. A valid example for this field would look like: http://localhost:8022/Service/ExecuteService |
| Parameters |
Collection |
Parameters that must accompany the request. A parameter consists of a name-value pair and can be configured using the displayed editor. Note that values will be URL encoded when the service is called.
Using the parameters defined in the example above, a query string with the following format will be generated (note that parameters have not been URL encoded to improve readability):
origin=Cape Town&destination=Johannesburg&sensor=false&alternatives=true
|
| ResponseFields |
Collection |
The structure of the data that is being returned from the web service. Supported return formats are JSON and Xml. Any other format will result in an error. After the service has executed, Linx will map the return result to the specified structure. Fields that are specified in the return structure that is not present in the response will be ignored. An error will occur if the mapping is not successful, e.g. when you try to map an array return value to a simple type like a string. It is not necessary to create structure mappings for all of the return values of a service. Only specify the values that you intend to use, but do ensure that they are specified on the correct level (correct parent element, etc.). Return values that do not have a mapping specified will be ignored.
When specifying the structure, use Linx table types for array return values and Linx record types for object return values.
 |