Use the Connect-REST method to start an HTTP request/response interaction between the Pega Platform and the external system identified by a Connect REST rule ( Rule-Connect-REST rule type).
This method accepts three required and one optional parameter.
|ServiceName||Service name of the Connect REST rule to run.|
|EndPointURL||Optional. Specify the URL of an external system to which you want to connect. A value specified for this parameter overrides the value set in the End Point URL field on the Service tab of the Connect REST rule.|
|MethodName||HTTP method to execute. Select GET, POST, PUT or DELETE.|
Select to indicate the timing of execution
The Connect-REST method works as follows:
- Using rule resolution, locates the Connect REST rule identified by the ServiceName parameter and the class of the step page or primary page.
- Uses the HTTP method identified by the MethodName parameter to assemble a HTTP request message.
- If the step page does not exist, creates a new page, of the class identified in the Pages & Classes tab.
Checks whether simulation is in force for this rule. If true, results depend on the
Execution mode value:
Run— Executes the simulation activity synchronously
Run In Parallel— Executes the simulation activity in a separate requestor
Queue— Queues the simulation activity
If simulation is not in force, calls the Web service, or queues the request, depending
on the Execution mode value:
Run— Calls the Web service and waits for a response.
Run In Parallel— Executes in a separate requestor. (This temporary requestor has the same access group and clipboard as the original. At most 10 such child requestor sessions can be active at once.)
Queue— Creates a queue item based on the class and other characteristics identified in the Connect Request Processor, for later background processing by the Pega-IntSvcs agent.
- Processes the response message when it is received. (No response is available for queued connector requests.)
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.