Skip to main content

RobotManagerRestClient

Suggest edit Updated on November 10, 2021

A RESTful application, like Pega Robot Manager, uses standard verbs like get, post, put, delete, and so on to retrieve and send data to and from a remote server.

Use the RobotManagerRestClient component in Pega Robotic Automation to make a call to a REST API endpoint that Pega provides in a Pega Robot Manager environment. If the system returns data as a result of the REST API call, then you can retrieve this data and use it in automation. This component uses the JSON (JavaScript Object Notation) format to make the request and for output from the request.

When you add this component to an automation, the system places it on the Global tab of the component tray. This component must be global so other automations in the project can reference it.

To use this component, you supply parameters to the Robot Manager REST Client component before you execute methods against the targeted REST endpoint. The system presents these parameters for you to use and set in automations. Here is a summary of the available parameters:

InputParameters: Specifies input parameters using key value pairs. The system then uses these key value pairs to generate the JSON body for the request. Click this property to open the Input Parameter Editor where you specify the name and values for these inputs.

OutputParameters: Automatically generates the output parameters returned by the REST call by making a REST call with a valid URI, HTTP method, and input parameters. You can also manually add output parameters if you are unable to perform a REST call at this time.

Output parameter editor

The Output Parameter Editor includes the following fields.

Fields in Output Parameter Editor

FieldDescription
Server URIDefines the endpoint used for the REST call.
HTTP Method Specifies which HTTP method to use for the REST call. You can choose from the following options: GET, PUT, POST, DELETE, HEAD, PATCH, OPTIONS, CONNECT, and TRACE.
Input Method Allows you to use the input parameters that you have already specified for the component or to provide raw input.
Output Parameters Lists the output parameters that you added. Also lists the output parameters that the system returns when you test a REST call.
Raw Output Displays the raw JSON output that the system returns with the REST call.

Use the Add and Remove buttons to add or remove output parameters from this list. You can also move the parameters up and down to modify the order in which they appear. The Clear button removes all output parameters.

Click Validate to tell the system to use the information in the Server Details section to generate the output parameters list. After the system generates the parameters list, make the REST call.

Click OK to save your settings and close the form. Click Cancel to close the form without saving settings.

ParameterDefinition
UriQueryparameters

Specifies input parameters using key value pairs. The system uses these parameters to generate the URI query string. Click this property to open a window where you can specify the name and values for these inputs.

After you define these input parameters, be sure to call the SetUriQueryWithParameters method. This method automatically sets the UriQueryString property.

Note: Call this method before you use any of the execute methods to invoke the REST call.

UriQueryStringDefines the part of the URI that contains parameters. Set this property to override the value of the UriQueryParameters property. Setting this property also overrides the URI query string that is set by the SetUriQueryWithParameters method.
AcceptDefines the accepted content type for the accept header. The default is application/json.
ContentTypeDefines the request content type. The default is application/json.
CustomHeadersDefines custom headers for the request as key value pairs. Click this property to open the Custom Header Editor window where you can define the custom headers.
HttpMethodDefines the HTTP method for the request. You can choose from the following options: GET, PUT, POST, DELETE, HEAD, PATCH, OPTIONS, CONNECT, and TRACE.
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us