Skip to main content

RestClient component

Suggest edit Updated on November 10, 2021

Use this component to make a REST API call. If the REST API call returns output data, you can retrieve this data and use it in an automation. This component uses the JSON format for making the request and for receiving output from the request.

When you add this component to an automation, Pega Robot Studio places the component on the Global tab of the component tray. Make this component global so other automations in the project can reference it. You can find this component in the Advanced section of the Pega Robot Studio toolbox.

This component works similarly to the Pega Robot Manager REST Client component except you can use it for any REST call instead of only for REST calls to Robot Manager. This component also differs from the Robot Manager REST Client component in the following ways:

  • You can set the ServerUriBase property. This property is not read-only. This component does not read from the CommonConfig.xml file as the Robot Manager REST client component does.
  • The UseRobotManagerConnection, Username, and Password component properties for the adapter are removed. These properties are only applicable to the Robot Manager REST client component.
  • The Authorization and UseDefaultCredentials parameters and methods are available for this component.

Parameters

ParameterDescription
AuthorizationDefines the authorization header value of the request. Click this parameter to open the Authorization Header Editor and set the authentication method as Basic, Bearer, Custom, or None.
UseDefaultCredentialsSpecifies whether you sent the default user credentials for the currently logged in user with the request.
ClearAuthenticationClears what is set in the authorization header in the component properties of the automation.
SetBasicAuthenticationSets the authorization header as Basic. This parameter has two string input parameters, username and password.
SetBearerAuthenticationSets the authorization header as Bearer. This parameter has one string input parameter, token.
SetCustomAuthenticationSets the authorization header as Custom. This parameter has one string input parameter, value.
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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