Back ForwardIntegration category
— Create REST integration

Use the wizard to integrate data from a new REST data source into your application. The wizard guides you through the process; use the breadcrumbs at the top of the wizard to return to a previous screen at any time.

The wizard has five steps:

Click Cancel at any time to exit the wizard without creating any new records.

Enter URL

Enter the URL for this new service in the field provided, then click Next >.

Note: you cannot use a fully-formed XSD to create the service.

Define Parameters

The wizard analyzes the URL you provided and suggests the elements that represent parameters. Normally the wizard will display options either in the Edit Resource Paths table or the Query String Parameters table, depending on which structure the URL and the data source use.

Check the checkbox beside each element of the URL that is a parameter. A resource path that is marked as a parameter is considered part of the request. The system generates a property as part of the request data model and substitutes that property's value for that part of the URL at runtime. This is denoted in the URL at the top by the parameter's name in brackets.

Query string parameters are always considered part of the request; a property will be created for them as well.

Add additional parameters by clicking the relevant + icon and providing parameter details.

When you are ready, click Next >.

Select Methods

Verify the Data Source Name. This is how you refer to this data source from data pages and activities when using it.

If this connector requires authentication, click the "Edit Authentication" link. In the form that appears, specify an authentication profile to use for these data sources. You can enter a new name to configure a new authentication profile to use.

For the selected profile provide:

Click OK to save the configuration.

The standard methods for obtaining data from a REST service are GET, POST, PUT and DELETE. Check the checkbox beside each method you want to use as a data source in your application.

Note: in release 7.1.6 if you select multiple methods, the wizard only creates the top one selected.

To the right of each selected method are two buttons.

When you are ready, click Next >.

Generate Records

Review and, if necessary, update information about this connector

Select the Generate checkbox beside the Data Layer label to automatically create a data type, data page, and related data transforms for this connector.

Click the "Edit" link to display a form where you can specify the details for the data layer to be created:

Check the Include top node in Data Layer checkbox to include data from the top or root node of the schema in data layer generation. This is not usually necessary.

Click OK to save your settings and close the form. Click Cancel to abandon your changes and close the form. A summary of the objects to be created, and their location, appears below the checkbox and link.

For more about the data layer, see data page.

On the main form, click Preview to see a summary of the records that the system will create to provision this connector.

When you are ready, click Create to create the connector (and, optionally, the related data page) and see a summary of the records and classes created.

Generation Summary

On the final display you can review the records that were created and their location. Click Undo Generation to cancel creation of the integration and remove the created records. Click OK to close the form.

Using OAuth with a REST integration

You need to obtain an access token to use OAuth with a REST connector, before you invoke the connector. Run the standard activity OAuth-Client.pyConnectSocialNetwork. The activity takes the OAuth Client data instance name as a parameter and returns an access token. Do not call this activity from the same activity that invokes the Connect-REST method.

The system stores the access token in the database with the operator ID of the operator used to invoke pyConnectSocialNetwork and the consumer key from the OAuth client data instance as keys.

To make a REST call to an OAuth protected resource using the consumer key, associate an authentication profile with the connector. Set the Authentication Scheme to OAuth and reference the OAuth client data instance that corresponds to the consumer key for which you obtained the access token.

UpIntegration category - Connectors page
UpDesigner Studio — About Landing Pages

Help System home pageHelp Home