Skip to main content

 –

Creating a data object and connecting it to a system of record using REST

Suggest edit Updated on August 16, 2021

Add data objects to your application to define and store data, for example, customer addresses, then integrate them with data from an external source 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 New.
  3. In the Data objects name field, enter a name for the new data object.
  4. In the Define source data field, select Now.
  5. Click Next.
  6. In the System list, select a system of record.
    • Create new – Create a new system to connect to an external database using a REST connection.
    • Other system – Connect to an external database using a REST connection.
  7. Optional: If you want to create a data model by using a spreadsheet, see Creating a data model from a spreadsheet.
  8. Click Submit.
  9. In the Connection section, choose whether to connect to an endpoint URL or an OpenAPI specification.
    ChoicesAction
    Enter endpoint URL
    1. In the Method field, choose the connection method, GET or POST.
    2. In the Endpoint URL field, enter the enter the endpoint URL of the data.
    3. In the Parameters section, choose which parts of the URL are dynamic and need to be parameterized for future calls.
      1. Select the URL part that you want to parameterize.
      2. In the Parameter name field, enter the name.
    4. In the Headers section, click Add header to specify a request header and its value. Some services require extra information, for example, API version.
    5. Specify and configure the authentication method. For more information, see Providing authentication details.
    6. Advance to the Data mapping page. For more information, see Mapping fields for data pages.
    Use openAPI
    1. For more information about connecting to an OpenAPI Specification, see Integrating with a REST API by using OpenAPI Specification.
    2. Click Next to advance to the Data mapping page. For more information, see Mapping fields for data pages.
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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