Service REST rules
|
|
Records can be created in various ways. You can add a new record to your application or copy an existing one. You can specialize existing rules by creating a copy in a specific ruleset, against a different class or (in some cases) with a set of circumstance definitions. You can copy data instances but they do not support specialization because they are not versioned.
Based on your use case, you use the Create, Save As, or Specialization form to create the record. The number of fields and available options varies by record type. Start by familiarizing yourself with the generic layout of these forms and their common fields:
This information identifies the key parts and options that apply to the record type that you are creating.
NOTE: Before you begin creating a Service REST rule, create or identify a Service Package data instance; the name of the service package becomes the first key part of the Service REST rule.
Create a Service REST rule by selecting Service REST from the Integration-Services category.
A Service REST rule has three key parts:
Field |
Description |
| Label | Enter a short description for this record. |
|
Identifier |
Enter an arbitrary identifier that describes the function of the Pega Platform activity called by this service. See How to enter a Java identifier. |
| Customer Package Name |
Select the name of the Service Package data instance for this service rule. See About Service Package data instances. If your application is to process requests from this service asynchronously through a background agent, define a Service Request Processor data instance (Data-Admin-RequestProcessor-Service class) with this Customer Package Name value as key. |
| Customer Class Name |
Enter a name that logically groups related service methods (service rules). This name is unrelated to Rule-Obj-Class instances; it must be a valid Java identifier. See How to enter a Java identifier. |
When searching for a Service REST rule, the system filters candidate rules based on a requestor's RuleSet list, which defines the RuleSets and versions the requestor can access.
Circumstance-qualified and time-qualified resolution features are not available for Service HTTP rules. The class hierarchy is not relevant to Service REST rule resolution.