REST Service Configuration Dialog Box

This dialog box opens when you click the Configure URL button on the General tab of the Property Editor for the REST Grid widget. It lets you add or change widget parameters.

The following table describes the configuration settings for a REST service.
Element Description

Type or paste the URL of the REST service. Any input parameters are immediately added to the Inputs section, and the sample data and outputs columns are automatically populated.

When you type a URL to a REST service that requires authentication, a popup window is presented, in which you type a user name and password.

If the REST service is implemented locally, the URL would likely need to be modified before deployment to point to the appropriate environment. For example, a REST service in a staging environment might contain "dummy" data, while the same REST service in a production environment would return real customer records. If you choose to use the URL generated by SBM Composer, use the New Endpoint Dialog Box to change the server part of URL to point to the correct environment. (You can also change the URL in SBM Application Repository before promotion.)


Use SSO: Select this check box if to pass a Single Sign-On (SSO) token to the REST service for authentication to retrieve sample data.

Important: This option only applies if SSO is enabled for SBM. It should not be used with non-SBM REST services for security reasons and because some REST services will fail if the token is not expected.

Displays input parameters that are sent to a REST service. The parameters are populated when you provide a URL.

You can set new default values for input parameters that override ones set in a provided URL. These parameter values can be changed later on the Query tab. The URL is updated after you change a parameter name or value, and then click somewhere else or press the Enter key.

Add input

Adds add a new input parameter. When you add a new parameter, the URL is immediately updated.

Remove input Removes the selected input parameter.
Sample data Displays sample data from the REST service.

Select the Wrap check box to wrap the sample data so it is visible without scrolling.

Select the Format check box to properly format the data.

Get Sample Data Populates the sample data column based on the REST service URL and any URL parameters. Use the button to initially populate the column or to refresh the sample data from the URL after you edit the data.
Edit Sample Data Use to modify sample data. For example, you may want to duplicate repeating data. You can also import data. For details, refer to Edit Sample REST Data Dialog Box.
Displays output structure received from a REST service. Formatting hints include:
  • Bold nodes can be displayed in the widget.
  • Disabled nodes cannot be displayed in the widget.
  • Repeating nodes are shown as arrays (with [] after the name).
  • The array that is selected to be displayed in the widget is shown in bold italic text.
Bypass browser cache Always goes directly to the server to get results, rather than relying on the browser cache. Select this check box if your REST results change over time and you want to have the latest data, not the cached data.
Ignore XML prefixes Specify whether XML namespace prefixes should be ignored.

Namespace prefixes are arbitrary, can be automatically generated, and can change. The REST Grid widget requires a constant namespace prefix, so if the prefix changes, the widget does not work. If you select this check box, the namespace prefix that is returned in the data from the REST service is not used, so the widget works consistently.

This check box is present only if you specified a REST service address that returns XML (an XML REST Web service, not a JSON REST Web service).

Rows data

Defines the array in the data set to be used for rows in the grid. The first available array is selected by default, but the list can be edited if more than one array is present. If no arrays are detected, the list includes all potential elements, and at runtime, the user must select the element that will contain repeating data.