Skip to main content

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

Connecting existing data objects to a system of record using REST

Updated on November 23, 2022

To integrate your application with data from an external source, you connect data objects to a system of record using REST.

Before you begin: Read the API documentation for the REST service that you choose, to determine the supported endpoints, parameters, and authentication protocol. You can then work with your system administrator to find or create the relevant authentication profile.
  1. In the navigation pane of App Studio, click Data.
  2. Click Data objects and integrations.
  3. Click an existing data object that is not connected to an external system of record.
  4. Click the Data views tab and choose one of the following options:
    • If your data object is not connected to a system of record, click Connect to system of record.
    • If your data object is connected to Pega database storage, in the row of the data view with the source that you want to replace, click MoreReplace source.
      Note: If you are replacing an aggregate source, the new source replaces the entire aggregate source. You cannot replace the individual sources within the aggregate source.
  5. In the System field, select a system of record.
    • Create new – Create a new system to connect to an external database by using a REST connection. Then, enter a name and a description for the new system.
    • Use an existing system – Select the name of an existing system to connect to an external database by using a REST connection.
  6. In the Connection details section, in the Method field, select the connection method, GET or POST as the connection method.
  7. In the Endpoint URL field, enter the endpoint URL of the data.
  8. In the Parameters section, choose which part of the URL are dynamic and need to be parameterized for future calls.
  9. In the Headers section, click Add header to specify a request header and its value. Some services require extra information, for example, API version.
What to do next: Specify and configure the authentication method. For more information, see Providing authentication details.
  • Providing authentication details

    Configure how to authenticate with your system of record.

  • Mapping fields

    Select the data that your application needs for processing by mapping fields from the REST response or a JSON file to the data view.

  • Previous topic Mapping fields for the POST method when creating a data object
  • Next topic Providing authentication details

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us