Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Creating a REST integration

Updated on November 23, 2022

You can create data sources in your application by using standard methods to obtain data from external REST services. You can also configure the authentication for the data sources by using a basic, NTLM, or OAuth 2.0 authentication scheme. When you use the Create REST Integration wizard to create a data source, the system generates the records that are required to use the data source. These records include classes, properties, mapping rules, data transforms, a connector, a data page, and optionally, an authentication profile, an OAuth 2.0 provider, and an access token.

  1. To begin creating a REST integration, in the header of Dev Studio, click ConfigureIntegrationConnectorsCreate REST Integration.
  2. Configure the REST connection.
  3. Select methods for REST integration.
  4. Define the data model for REST integration.
  5. Update and generate records for REST integration.
  6. Review the record generation summary.
What to do next:

Next: Configuring the REST connection

  • Configuring a REST connection

    On the Connection page of the Create REST Integration wizard, you can configure the connection of your system with the external REST service.

  • Selecting methods for REST integration

    On the Resource methods page of the Create REST Integration wizard, you can choose the standard methods to use for the creation of a data source in your application and override the headers for each method.

  • Defining a data model for REST integration

    On the Data model page of the Create REST Integration wizard, you can define the data model for your REST integration by adding a REST response or uploading a file. The system parses sample requests and responses to determine the data model.

  • Updating and generating records for REST integration

    On the Review page of the Create REST Integration wizard, you can review and update the information for the integration and data layers of your REST integration and generate the records for these layers.

  • Reviewing the record generation summary

    On the Generation Summary page of the Create REST Integration wizard, review the records that were created for your REST integration and their location. You can review the record generation summary when the record generation is in progress and after the records are generated.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us