Creating a REST service

You can create REST services to expose the REST APIs that can be called by another application to invoke an action or to retrieve data from Pega Platform. You need a service package and a REST service rule to create and expose a REST service from your application.

Before you begin: Before you create a REST service rule, create or identify the service package instance to which the service belongs. Each service belongs to a single service package. The name of the service package becomes the first key part of the REST service rule. The service package determines the complete URL and the security settings for invoking the service. For more information, see Creating a service package.
  1. In the header of Dev Studio, click Create > Integration-Services > Service REST.
  2. In the Service REST Record Configuration section, in the Service name field, enter a label for the REST service rule.
  3. In the Service package name field, press the Down arrow key, and then select the service package for the REST service rule.
  4. In the Service version field, enter the implementation version for the REST service rule.
  5. Create a new URI template:
    1. Click Build URI.
    2. In the Build URI Template window, click Add.
    3. In the URI component column, specify the name of the URI component.
    4. In the URI component type column, specify one of the following values:
      • Literal
      • Variable
      Note: The first component in a URI template must be a literal component. For more information, see URI template component requirements.
    5. Click Submit.
  6. Click Create and open.
  7. On the Service tab, configure the URL path parameters mapping, data transform, and other configuration options for your service.
    For more information about the service parameters, see Service REST form - Completing the Service tab.
  8. On the Methods tab, identify the activity that is called by each method in the service REST rule.
    For more information about the parameters for methods, see Service REST form - Completing the Methods tab.
  9. Click Save.