RESTful Configuration

Drop-down list that determines whether "-" or "%20" is used as the escape character(s) for typed spaces in the URL Query String. Default is "Plus (-)".


Example:

Plus (-): http://localhost:8088/main/system/ws/rest/test?test=string-with-spaces
Percent (%20): http://localhost:8088/main/system/ws/rest/test?test=string%20with%20spaces

Depending on the Web Service, these can be used to identify the format of the body object you are POSTing to the web service, or perhaps an API key or other identifying tool. A standard Request Header Item would be Content-type which can be used to indicate the format of the body object. The most common value for Content-type is application/json, but this is entirely dependent upon the web service you are posting to and the data format you are posting.

Other common mime-types are...

These are additional paths appended to the end of the URL, divided by slashes. For example: http://demo.sepasoft.com/main/system/webdev/WebServicesAPI/getProductCodeList?filter=SA contains "/main", "/system", "/webdev", "/WebServicesAPI" and "/getProductCodeList" as resource paths.

URL Resource Path entities are created in the RESTful Configuration as shown to the right (they are appended in the order they are listed).

This section can be created to represent an XML- or JSON-format Request Body. The XML Request Body can include XML attributes, as shown in the example below.

The above example is translated into the XML representation below and sent in the POST body to the remote web server:

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<complexArray complexAttribute1="Hello" complexAttribute2="World">
		<simpleVal simpleValAttr1="1" simpleValAttr2="2">3</simpleVal>
	</complexArray>
</root>

When Add New Item is clicked, the following dialog box appears, to allow selecting the category of item to add.

When Edit Selected Item is clicked, a dialog box with the settings for the selected row will appear.

Copies the completed 'runWebService' scripting function required to run the RESTful Consumer to the computer clipboard (can be pasted anywhere).

Here is an example copied script pasted into the Script Console and executed. Note the returned Response Message on the right.

When Add New Item is clicked, the following dialog box appears, to allow selecting the category of item to add. This function applies only to complex and array data types.

When Edit Selected Item is clicked, a dialog box with the settings for the selected row will appear.

If you do not have a JSON or XML Response Message from the intended RESTful Provider, click this icon and a live Request Message will be issued (with the provided default values appended in the URL Query String). Upon receiving the Response Message, it will be parsed to extract the Response Conversion rows and populate in the Response Message area.

Make sure to click Save in Designer before clicking this Run Web Services Configuration button.