Skip to main content

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

Service REST rules

Updated on April 6, 2022

Representational State Transfer Protocol (REST) applications use HTTP instead of the more complex SOAP protocol to make calls between machines. The REST integration interface in the Pega Platform supports interactions with external systems through Web services.


Use the Application Explorer to see Service REST rules in your application. Use the Records Explorer to list all Service REST rules that are available to you.


Service REST rules belong to the Integration-Services category. A Service REST rule is an instance of the Rule-Service-REST class.

Performance logging

You can collect performance statistics about the resources used by a service in a Comma-Separated-Values (CSV) file, accessed from the Log menu. See Performance tool — Statistics for services in the SERVICES-PAL log.

You can trace the operation of a Service REST rule and the service activity it calls. See Tracing services.

  • Creating a Service REST rule

    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.

  • Defining resource and processing details for a Service REST rule

    Use the Service tab of the Service REST rule to configure the mapping of the URL path parameters, data transforms, and other configuration options for your service.

  • Service REST methods

    You can use the following methods when you configure Service REST rules.

  • More about Service REST rules
  • Distinct URI specification for service REST rules

    Different service REST rules are specified for different resource URIs. This functionality provides different processing options, request handling, and response handling for each distinct resource URI. Additionally, it eliminates the need to maintain complex logic used to handle all possible resource URI paths.

  • URI template component requirements

    The variable and literal components of a URI template require specific formatting. Apply these requirements to URI templates when you define different service REST rules for distinct resource URIs.

  • Service REST monitoring

    You can monitor Service REST request and response data and view the results of rule invocation by using a combination of dynamic system settings and options on the Service Package and Service REST rule forms. Monitoring is useful for debugging your application during development, for example, if a request is failing.

  • Invoking a REST service rule

    Call a REST service rule from an external system to invoke an action in your application or retrieve data from Pega Platform. For example, you can call a REST service to get the details of a case or assignment. You can specify the application context in which to run the API by using the application alias URL.

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