LinkedIn
Copied!

Table of Contents

Creating a Service REST rule

Version:

Only available versions of this content are shown in the dropdown

You can create Service REST rules 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 Service REST rule to create and expose a Service REST from your application.

Before you create a Service REST 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 Service REST 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 Service REST rule.

  3. In the Service package name field, press the Down arrow key, and then select the service package for the Service REST rule.

  4. In the Service version field, enter the implementation version for the Service REST rule.

  5. Create a new URI template to map a resource URI with a service REST rule:

    Use a URI template to define multiple URIs with similar structures. Templates contain a path and a query. For more information, see Distinct URI specification for service REST rules.
    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: A literal value does not change. For example, if you are configuring a service endpoint URL to fetch the next stage of a case, the literal value could be /cases.
      • Variable: A variable value can change depending on the information that the service is fetching. For example, for a service endpoint that is fetching the next stage of a case, {caseID} is a variable value. The case ID can change based on the case for which you are fetching the next stage.
      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.

  8. On the Methods tab, identify the activity that is called by each method in the service REST rule.

    For more information, see Service REST methods.

Have a question? Get answers now.

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